GetObjectByTag

Returns the nth specified object with the appropriate tag

object GetObjectByTag(
string sTag,
int nNth = 0
);

Parameters:

sTag

The tag reference to get the object by

nNth

If there are multiple objects with the same tag, get the 'nth' specified object

Returns:

the desired object or OBJECT_INVALID on failure

Source:

script.ldf

Description

Returns the nth specified object with the appropriate tag

Remarks

GetObjectByTag only gets objects that are currently loaded into memory, meaning any objects in the current area list (active or inactive), as well as objects like world maps and map locations (also anything in the char_stage area).