nearestLocations
Jump to navigation
Jump to search
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:
- Locations
Syntax
- Syntax:
- nearestLocations [centre, locationTypes, radius, sortPosition]
- Parameters:
- centre: Array format Position2D, Position3D or Object
- locationTypes: Array of Strings - list of location type names, e.g "NameCity"; 2.14 passing empty array [] will return all available locations within the radius
- radius: Number - maximum distance from the given position that returned locations may be, in metres
- sortPosition: Array format Position2D, Position3D or Object - (Optional) results will be sorted from the distance to given sortPosition (nearest to farthest still)
- Return Value:
- Array of Locations
Examples
- Example 1:
- Example 2:
- Find any of nearest locations:
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
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.08
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Locations