nearestLocations: Difference between revisions
Jump to navigation
Jump to search
m (see also & example formate) |
Killzone Kid (talk | contribs) (accepts object as position) |
||
| Line 14: | Line 14: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | '''nearestLocations''' [position, [locationType,...], radius] |= Syntax | ||
|p1= [position, [locationType,...], radius]: [[Array]] |= Parameter 1 | |p1= [position, [locationType,...], radius]: [[Array]] |= Parameter 1 | ||
|p2= position: [[ | |p2= position: [[Position2D]], [[Position3D]] or [[Object]] |= Parameter 2 | ||
|p3= [locationType,...]: [[Array]] An array of location type name [[String|strings]] |= Parameter 3 | |p3= [locationType,...]: [[Array]] An array of location type name [[String|strings]] |= Parameter 3 | ||
|p4= radius: [[Number]] The maximum distance from the given position that returned locations may be, in meters. |= Parameter 4 | |p4= radius: [[Number]] The maximum distance from the given position that returned locations may be, in meters. |= Parameter 4 | ||
Revision as of 23:15, 20 June 2015
Description
- Description:
- Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
- Groups:
- Uncategorised
Syntax
- Syntax:
- nearestLocations [position, [locationType,...], radius]
- Parameters:
- [position, [locationType,...], radius]: Array
- position: Position2D, Position3D or Object
- [locationType,...]: Array An array of location type name strings
- radius: Number The maximum distance from the given position that returned locations may be, in meters.
- Return Value:
- Array of locations
Examples
- Example 1:
_nearbyLocations = nearestLocations [ position player, ["RockArea","VegetationFir"], 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