Difference between revisions of "GetNearestObjectByGroup"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetNearestObjectByGroup | |name=GetNearestObjectByGroup | ||
| − | |brief=Returns N nearest | + | |brief=Returns N nearest objects of a specific type, with a specifc Group Id |
|param1type=object | |param1type=object | ||
|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= | ||
| − | |returntype=object | + | |param7default=0 |
| − | |returndesc= | + | |returntype=object |
| + | |returnarra=1 | ||
| + | |returndesc=array of N nearest objects | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 32: | Line 39: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | Returns N nearest | + | Returns N nearest objects of a specific type, with a specifc Group Id |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 22:08, 2 March 2010
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
