nearestLocation: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma1 | | arma1 | ||
|1.08 | |1.08 | ||
|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). | | Return the closest location of specified class to a given position.<br>Checked range is unlimited (i.e. covers the whole map). | ||
| [[nearestLocation]] [position, locationClass] | | [[nearestLocation]] [position, locationClass] | ||
|p1= [position, locationClass]: [[Array]] | |p1= [position, locationClass]: [[Array]] | ||
|p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] | |p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] | ||
|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]] | ||
| [[Location]] | | [[Location]] | ||
|x1= <code>_nearestCity = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];</code> | |x1= <code>_nearestCity = [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"];</code> | ||
|x2= <code>_anyNearestLocation = [[nearestLocation]] [<nowiki/>[[player]], ""];</code> | |x2= <code>_anyNearestLocation = [[nearestLocation]] [<nowiki/>[[player]], ""];</code> | ||
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]] | | [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]] | ||
}} | }} | ||
Revision as of 01:11, 18 January 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