nearestObjects: Difference between revisions
Jump to navigation
Jump to search
m (added note - finding classless objects) |
m (removed note, it was already explained in description.) |
||
| Line 31: | Line 31: | ||
|p1= '''Classname''': [[String]] | |p1= '''Classname''': [[String]] | ||
This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames or an empty array to return all the objects within its radius.|=Parameter 1 | This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames, or an empty array to return all the objects within its radius.|=Parameter 1 | ||
|p2= '''radius''': [[Number]] Max radius in meters within which the object is searched for. |= Parameter 1 | |p2= '''radius''': [[Number]] Max radius in meters within which the object is searched for. |= Parameter 1 | ||
| Line 50: | Line 50: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
Revision as of 13:57, 21 November 2007
Description
- Description:
- Returns a list of nearest objects of the given types to the given position or object, within the specified distance. Pos can use the format: [[x,y,z], ["ClassName",...], radius] or [object, ["ClassName",...], radius]. A list of ClassName types (Tanks eg) can be found in CfgVehicles If more than one object is found they will be ordered according to their distance (i.e. the closest one will be first in the array).
- Groups:
- Uncategorised
Syntax
- Syntax:
- Source array can be a simple array or an array of arrays.
- Parameters:
- Classname: String This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames, or an empty array to return all the objects within its radius.
- radius: Number Max radius in meters within which the object is searched for.
- Return Value:
- Array
Examples
- Example 1:
nearestObjects [player, ["Car","Tank"], 200]- Example 2:
nearestObjects [player, ["house"], 200]- Example 3:
nearestObjects [[2716,2949,0], ["Car","Truck"], 100]
Additional Information
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note