Difference between revisions of "GetNearestObjectToLocation"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetNearestObjectToLocation | |name=GetNearestObjectToLocation | ||
| Line 5: | Line 4: | ||
|param1type=location | |param1type=location | ||
|param1name=lLocation | |param1name=lLocation | ||
| − | |param1desc= | + | |param1desc=Location from which to begin the search |
| + | |param1default= | ||
|param2type=int | |param2type=int | ||
|param2name=nObjectType | |param2name=nObjectType | ||
|param2desc=type for the objects to query for their distance | |param2desc=type for the objects to query for their distance | ||
| + | |param2default=OBJECT_TYPE_ALL | ||
|param3type=int | |param3type=int | ||
|param3name=nNumberOfObjects | |param3name=nNumberOfObjects | ||
|param3desc=(optional) Number of objects to return | |param3desc=(optional) Number of objects to return | ||
| − | |returntype=object | + | |param3default=1 |
| − | |returndesc= | + | |returntype=object |
| + | |returnarra=TRUE | ||
| + | |returndesc=Array of N nearest objects of a specific type | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
Latest revision as of 22:08, 2 March 2010
N nearest objects of a specific type to a Location
object[] GetNearestObjectToLocation(
location lLocation,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1
);
location lLocation,
int nObjectType = OBJECT_TYPE_ALL,
int nNumberOfObjects = 1
);
- Parameters:
- lLocation
- Location from which to begin the search
- nObjectType
- type for the objects to query for their distance
- nNumberOfObjects
- (optional) Number of objects to return
- Returns:
- Array of N nearest objects of a specific type
- Source:
- script.ldf
Description
Returns N nearest objects of a specific type to a Location
