nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "") |
Lou Montana (talk | contribs) m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ") |
||
Line 21: | Line 21: | ||
{{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} | {{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} | ||
|s1= | |s1= [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] | ||
|p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] | |p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |
Revision as of 22:17, 19 June 2021
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