nearestLocation: Difference between revisions

Revision as of 19:27, 30 July 2023

Hover & click on the images for description

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

Syntax:: nearestLocation [position, locationType, maxDistance]
Parameters:: position: Object or Array in format PositionAGL or Position2D
: locationType: String of a location class name. If "" is supplied, any nearest location is returned, or (since Arma3 2.14) Array of location types. See Location Types
since 2.14: maxDistance (Optional): Number - max search radius. Default - unlimited range.
Return Value:: Location

See also:: findNearestEnemy nearestBuilding nearestObject nearestObjects nearObjects nearEntities nearTargets nearSupplies nearestLocationWithDubbing nearObjectsReady nearRoads Location Types locationPosition nearestLocations createLocation nearestMines

: 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 20: / Line 20: @@
 |descr= Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).
-|s1= [[nearestLocation]] [position, locationClass]
+|s1= [[nearestLocation]] [position, locationType, maxDistance]
 |p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]
-|p2= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned. See [[Location#Location Types|Location Types]]
+|p2= locationType: [[String]] of a location class name. If "" is supplied, any nearest location is returned, or (since Arma3 2.14) [[Array]] of location types. See [[Location#Location Types|Location Types]]
+|p3= maxDistance (Optional): [[Number]] - max search radius. Default - unlimited range.
+|p3since= arma3 2.14
 |r1= [[Location]]