GetNearestObjectByTag

From Dragon Age Toolset Wiki
Jump to: navigation, search

Returns N nearest object of a specific type, with a specifc tag

object[] GetNearestObjectByTag(
object oObject,
string sTag,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1,
int nCheckLiving = 0,
int nCheckPerceived = 0,
int nIncludeSelf = 0
);
Parameters:
oObject
target Object
sTag
Tag for the objects to query
nObjectType
type for the objects to query for their distance
nNumberOfObjects
(optional) Number of objects to return
nCheckLiving
(optional) only returns objects if they are alive
nCheckPerceived
(optional) only returns objects if they are within the perception radius
nIncludeSelf
[Undocumented]
Returns:

an array of objects meeting the criteria, sorted by distance from the target object

Source:

script.ldf

Description

Returns N nearest object of a specific type, with a specifc tag

Cite DavidSims: "GetNearestObjectByTag returns an array of all creatures in the current area with the given tag, sorted by distance to the specificied object."