GetNearestObjectByTag

From Dragon Age Toolset Wiki
Revision as of 18:50, 2 February 2010 by Eshme (Talk | contribs) (Description)

Jump to: navigation, search

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

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

[[object[] keyword|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:

[Undocumented]

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 wth the given tag, sorted by distance to the specificied object."