nearestLocations

Description

Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.

Note

Although locations can be placed in 3D with setPosition, nearestLocations' search result is sorted in 2D.

Syntax

nearestLocations [centre, locationTypes, radius, sortPosition]

Parameters:

• centre: Position2D, Position3D or Object
• locationTypes: Array of Strings - list of location type names, e.g "NameCity"; 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 metres
• sortPosition: Position2D, Position3D or Object - (Optional) results will be sorted from the distance to given sortPosition (nearest to farthest still)

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

See also

createLocation · nearestLocation · locationPosition · nearestLocationWithDubbing