nearestLocations: Difference between revisions

Revision as of 21:16, 13 June 2021

Game1 needed - Version1 needed

Hover & click on the images for description

Description:: Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
ⓘ
Although locations can be placed in 3D with setPosition, nearestLocations search result is sorted in 2D.
Groups:: Locations

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

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];

See also:: createLocation nearestLocation locationPosition nearestLocationWithDubbing

: 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

@@ Line 18: / Line 18: @@
 |gr1= Locations
-| Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
+|descr= Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
 {{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}}