nearestLocation: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - " |r1=[[" to " |r1= [[")  | 
				Lou Montana (talk | contribs)  m (Some wiki formatting)  | 
				||
| Line 18: | Line 18: | ||
|gr1= Locations  | |gr1= Locations  | ||
|descr= Return the closest location of specified class to a given position.  | |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, locationClass]  | ||
|p1= [  | |p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]]  | ||
|p2  | |p2= 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]]  | ||
Revision as of 18:25, 24 November 2021
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: 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 
Categories: 
- Scripting Commands
 - Introduced with Armed Assault version 1.08
 - ArmA: Armed Assault: New Scripting Commands
 - ArmA: Armed Assault: Scripting Commands
 - Arma 2: Scripting Commands
 - Arma 2: Operation Arrowhead: Scripting Commands
 - Take On Helicopters: Scripting Commands
 - Arma 3: Scripting Commands
 - Command Group: Locations