Difference between revisions of "GetObjectByTag"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
BryanDerksen (Talk | contribs) (add Craig's comment from talk) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetObjectByTag | |name=GetObjectByTag | ||
| Line 21: | Line 20: | ||
Returns the nth specified object with the appropriate tag | Returns the nth specified object with the appropriate tag | ||
| − | + | == Remarks == | |
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | |||
| + | 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). | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
Latest revision as of 17:51, 17 February 2010
Returns the nth specified object with the appropriate tag
- 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).
