Difference between revisions of "GetNearestObjectByGroup"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (array return type) |
BryanDerksen (Talk | contribs) |
||
| Line 33: | Line 33: | ||
|returntype=object | |returntype=object | ||
|returnarra=1 | |returnarra=1 | ||
| − | |returndesc= | + | |returndesc=array of N nearest objects |
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
Revision as of 22:08, 2 March 2010
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 objects of a specific type, with a specifc Group Id
object[] GetNearestObjectByGroup(
object oObject,
int nGroupId,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1,
int nCheckLiving = 0,
int nCheckPerceived = 0,
int nIncludeSelf = 0
);
object oObject,
int nGroupId,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1,
int nCheckLiving = 0,
int nCheckPerceived = 0,
int nIncludeSelf = 0
);
- Parameters:
- oObject
- target Object
- nGroupId
- Group Id 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:
- array of N nearest objects
- Source:
- script.ldf
Description
Returns N nearest objects of a specific type, with a specifc Group Id
