Difference between revisions of "GetNearestObjectByGroup"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) |
||
| (3 intermediate revisions by 2 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 | ||
| Line 31: | Line 30: | ||
|param7desc= | |param7desc= | ||
|param7default=0 | |param7default=0 | ||
| − | |returntype=object | + | |returntype=object |
| − | |returndesc= | + | |returnarra=1 |
| + | |returndesc=array of N nearest objects | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 39: | 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
