nearestLocation: Difference between revisions

Latest revision as of 18:11, 15 March 2024

1.08

Hover & click on the images for description

Description

Description:: Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).
ⓘ
Although locations can be placed in 3D with setPosition, nearestLocations search is conducted in 2D.
Groups:: Locations

Syntax

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. Since Arma 3 2.14 locationType could be an Array of location types. See Location Types
since 2.14: maxDistance: Number - (Optional) max search radius. Default - unlimited range.
Return Value:: Location

Examples

Example 1:: _nearestCity = nearestLocation [getPos player, "nameCity"];
Example 2:: _anyNearestLocation = nearestLocation [player, ""];

Additional Information

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

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

@@ Line 18: / Line 18: @@
 |gr1= Locations
-|descr= Return the closest location of specified class to a given position.<br>Checked range is unlimited (i.e. covers the whole map).
+|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]
+{{Feature|informative|Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search is conducted in 2D.}}
-|p1= [position, locationClass]: [[Array]]
+|s1= [[nearestLocation]] [position, locationType, maxDistance]
-|p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]]
+|p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]
-|p3= 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. Since Arma 3 2.14 locationType could be an [[Array]] of location types. See [[Location#Location Types|Location Types]]
-|r1=[[Location]]
+|p3= maxDistance: [[Number]] - (Optional) max search radius. Default - unlimited range.
+|p3since= arma3 2.14
-|x1= <code>_nearestCity = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];</code>
+|r1= [[Location]]
-|x2= <code>_anyNearestLocation = [[nearestLocation]] [<nowiki/>[[player]], ""];</code>
+|x1= <sqf>_nearestCity = nearestLocation [getPos player, "nameCity"];</sqf>
-|seealso= ‎[[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]]
+|x2= <sqf>_anyNearestLocation = nearestLocation [player, ""];</sqf>
+|seealso= [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearObjects]] [[nearEntities]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[Location#Location Types|Location Types]] [[locationPosition]] [[nearestLocations]] [[createLocation]] [[nearestMines]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}