nearestLocation: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Text replacement - " |r1=[[" to " |r1= [[")
Line 28: Line 28:
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned. See [[Location#Location Types|Location Types]]
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned. See [[Location#Location Types|Location Types]]


|r1=[[Location]]
|r1= [[Location]]


|x1= <code>_nearestCity = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];</code>
|x1= <code>_nearestCity = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];</code>

Revision as of 23:48, 7 August 2021

Logo A1 black.png 1.08Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=nearestLocation&oldid=292193"