nearestLocation

Description

Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).

Note

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

Syntax

nearestLocation [position, locationType, maxDistance]

Parameters:

• position: Object or PositionAGL or Position2D
• locationType: String of a location class name. If "" is supplied, any nearest location is returned. Since Arma 3 2.14 locationType could be an Array of location types. See Location Types
• maxDistance: Number - (Optional) max search radius. Default - unlimited range. (since arma3 2.14)

Returns: Location

Examples

Example 1

_nearestCity = nearestLocation [getPos player, "nameCity"];

Example 2

_anyNearestLocation = nearestLocation [player, ""];

See also

findNearestEnemy · nearestBuilding · nearestObject · nearestObjects · nearObjects · nearEntities · nearTargets · nearSupplies · nearestLocationWithDubbing · nearObjectsReady · nearRoads · Location · locationPosition · nearestLocations · createLocation · nearestMines