nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "Position3D" to "Position3D") |
Lou Montana (talk | contribs) m (Text replacement - "Position2D" to "Position2D") |
||
Line 23: | Line 23: | ||
|s1= [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] | |s1= [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] | ||
|p1= position: [[Array]] - [[Position2D]], [[Position#Introduction|Position3D]] or [[Object]] | |p1= position: [[Array]] - [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]] | ||
|p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity" | |p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity" | ||
Line 29: | Line 29: | ||
|p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | |p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | ||
|p4= sortPosition: [[Array]] - (Optional) [[Position2D]], [[Position#Introduction|Position3D]] or [[Object]] - results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) | |p4= sortPosition: [[Array]] - (Optional) [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]] - results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) | ||
|r1= [[Array]] of [[Location|locations]] | |r1= [[Array]] of [[Location|locations]] |
Revision as of 16:56, 5 January 2022
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 [position, [locationType1, locationType2, ...], radius, sortPosition]
- Parameters:
- position: Array - Position2D, Position3D or Object
- locationTypeX: String - location type name, e.g "NameCity"
- radius: Number - maximum distance from the given position that returned locations may be, in meters.
- sortPosition: Array - (Optional) Position2D, Position3D or Object - results will be sorted from the distance to given sortPosition (nearest to farthest still)
- Return Value:
- Array of locations
Examples
- Example 1:
_nearbyLocations = nearestLocations [position player, ["RockArea", "VegetationFir"], 100];
- Example 2:
- Find any of nearest locations:
private _allLocationTypes = []; "_allLocationTypes pushBack configName _x" configClasses (configFile >> "CfgLocationTypes"); { systemChat format [ "%1 (%2) - %3m", _x, text _x, position player distance _x ]; } forEach nearestLocations [player, _allLocationTypes, 500];
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