nearestLocation: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "\| *arma1 * * *\| *([0-1]\.[0-9]{2}) * \|game2" to "|game1= arma1 |version1= $1 |game2") |
Lou Montana (talk | contribs) m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "") |
||
| Line 36: | Line 36: | ||
|seealso= [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]] | |seealso= [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]] | ||
}} | }} | ||
Revision as of 22:37, 16 June 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, 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
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