nearestLocations

1.08 1.00 1.50 1.00 0.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 [centre, locationTypes, radius, sortPosition]

Parameters:

centre: Position2D, Position3D or Object

locationTypes: Array of Strings - list of location type names, e.g "NameCity"; 2.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 metres

sortPosition: Position2D, Position3D or Object - (Optional) results will be sorted from the distance to given sortPosition (nearest to farthest still)

Return Value:

Array of Locations

Examples

Example 1:

_nearbyLocations = nearestLocations [getPosATL 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, getPosATL 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.
Only post proven facts here! Add Note