nearestLocation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(One intermediate revision by one other user not shown)
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).
|descr= Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).


{{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search is conducted in 2D.}}
{{Feature|informative|Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search is conducted in 2D.}}


|s1= [[nearestLocation]] [position, locationType, maxDistance]
|s1= [[nearestLocation]] [position, locationType, maxDistance]
Line 28: Line 28:
|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]]
|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]]


|p3= maxDistance (Optional): [[Number]] - max search radius. Default - unlimited range.
|p3= maxDistance: [[Number]] - (Optional) max search radius. Default - unlimited range.
|p3since= arma3 2.14  
|p3since= arma3 2.14  



Latest revision as of 19:11, 15 March 2024

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 Arma 3 logo black.png2.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