nearestLocation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| (\[\[[a-zA-Z0-9 _]+\]\][^ ]*) \}\}" to "|seealso= ‎$1 }}")
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=0-9]{12})" to "|$1=$2 |descr=$3")
Line 18: Line 18:
|gr1= Locations
|gr1= Locations


| 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.<br>Checked range is unlimited (i.e. covers the whole map).


|s1=  [[nearestLocation]] [position, locationClass]
|s1=  [[nearestLocation]] [position, locationClass]

Revision as of 21:16, 13 June 2021

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).
Groups:
Locations

Syntax

Syntax:
nearestLocation [position, locationClass]
Parameters:
[position, locationClass]: Array
position: Object or Array in format PositionAGL or Position2D
locationClass: String of a location class name. If "" is supplied, any nearest location is returned. See Location Types
Return Value:
Location

Examples

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

Additional Information

See also:
findNearestEnemynearestBuildingnearestObjectnearestObjectsnearObjectsnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoadsLocation TypeslocationPositionnearestLocationscreateLocation

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