Difference between revisions of "GetNearestObjectByHostility"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
BryanDerksen (Talk | contribs) (fill in missing parameter, remove tag) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetNearestObjectByHostility | |name=GetNearestObjectByHostility | ||
| Line 31: | Line 30: | ||
|param7desc= | |param7desc= | ||
|param7default=0 | |param7default=0 | ||
| − | |returntype=object | + | |returntype=object |
| − | |returndesc= | + | |returnarra=true |
| + | |returndesc=An array of objects that match the parameters' criteria | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
Latest revision as of 19:31, 24 February 2010
Returns N nearest object of a specific type, with a specifc Hostility
object[] GetNearestObjectByHostility(
object oObject,
int nHostility,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1,
int nCheckLiving = 0,
int nCheckPerceived = 0,
int nIncludeSelf = 0
);
object oObject,
int nHostility,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1,
int nCheckLiving = 0,
int nCheckPerceived = 0,
int nIncludeSelf = 0
);
- Parameters:
- oObject
- target Object
- nHostility
- Hostility for the objects to query (true/false)
- 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:
- An array of objects that match the parameters' criteria
- Source:
- script.ldf
Description
Returns N nearest object of a specific type, with a specifc Hostility
