nearestLocations

1.081.001.501.000.50

Hover & click on the images for description

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

Syntax:

nearestLocations [position, locationTypes, radius, sortPosition]

Parameters:

position: Array - Position2D, Position3D or Object

locationTypes: Array of Strings - list of location type names, e.g "NameCity". Since Arma 3 v2.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 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

See also:

createLocation nearestLocation locationPosition nearestLocationWithDubbing

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