Difference between revisions of "GetNearestObjectByGroup"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
(Generated by Sunjammer's Dragon Age Script Paser) |
||
(One intermediate revision by the same user not shown) | |||
Line 6: | Line 6: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=target Object | |param1desc=target Object | ||
+ | |param1default= | ||
|param2type=int | |param2type=int | ||
|param2name=nGroupId | |param2name=nGroupId | ||
|param2desc=Group Id for the objects to query | |param2desc=Group Id for the objects to query | ||
+ | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nObjectType | |param3name=nObjectType | ||
|param3desc=type for the objects to query for their distance | |param3desc=type for the objects to query for their distance | ||
+ | |param3default=OBJECT_TYPE_ALL | ||
|param4type=int | |param4type=int | ||
|param4name=nNumberOfObjects | |param4name=nNumberOfObjects | ||
|param4desc=(optional) Number of objects to return | |param4desc=(optional) Number of objects to return | ||
+ | |param4default=1 | ||
|param5type=int | |param5type=int | ||
|param5name=nCheckLiving | |param5name=nCheckLiving | ||
|param5desc=(optional) only returns objects if they are alive | |param5desc=(optional) only returns objects if they are alive | ||
+ | |param5default=0 | ||
|param6type=int | |param6type=int | ||
|param6name=nCheckPerceived | |param6name=nCheckPerceived | ||
|param6desc=(optional) only returns objects if they are within the perception radius | |param6desc=(optional) only returns objects if they are within the perception radius | ||
+ | |param6default=0 | ||
|param7type=int | |param7type=int | ||
|param7name=nIncludeSelf | |param7name=nIncludeSelf | ||
|param7desc= | |param7desc= | ||
+ | |param7default=0 | ||
|returntype=object[] | |returntype=object[] | ||
|returndesc= | |returndesc= |
Revision as of 23:37, 31 July 2009
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 Group Id
[[object[] keyword|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:
- [Undocumented]
- Source:
- script.ldf
Description
Returns N nearest object of a specific type, with a specifc Group Id