nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma1 |Game name= | | arma1 |Game name= | ||
| Line 11: | Line 10: | ||
|gr1= Locations |GROUP1= | |gr1= Locations |GROUP1= | ||
| Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. | | Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. | ||
{{Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} |DESCRIPTION= | {{Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} |DESCRIPTION= | ||
| [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] |SYNTAX= | | [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] |SYNTAX= | ||
| Line 28: | Line 25: | ||
| [[Array]] of [[Location|locations]] |RETURNVALUE= | | [[Array]] of [[Location|locations]] |RETURNVALUE= | ||
|x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> |EXAMPLE1= | |x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> |EXAMPLE1= | ||
| Line 42: | Line 38: | ||
]; | ]; | ||
} [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code> |= | } [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code> |= | ||
| [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO= | | [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO= | ||
Revision as of 01:58, 17 January 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