nearestLocation: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= Game version" to "|Game version=") |
Lou Montana (talk | contribs) |
||
| Line 5: | Line 5: | ||
|1.08|Game version= | |1.08|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 14: | Line 10: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[nearestLocation]] [position, locationClass] |SYNTAX= | ||
|p1= [position, locationClass]: [[Array]] |PARAMETER1= | |p1= [position, locationClass]: [[Array]] |PARAMETER1= | ||
|p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER2= | |p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER2= | ||
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned.|PARAMETER3= | |||
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned. See [[Location#Location Types|Location Types]] |PARAMETER3= | |||
| [[Location]] |RETURNVALUE= | | [[Location]] |RETURNVALUE= | ||
| Line 24: | Line 22: | ||
|x1= <code>_nearestCity = [[nearestLocation]] [ [[getPos]] [[player]], "nameCity"];</code> |EXAMPLE1= | |x1= <code>_nearestCity = [[nearestLocation]] [ [[getPos]] [[player]], "nameCity"];</code> |EXAMPLE1= | ||
|x2= <code>_anyNearestLocation = [[nearestLocation]] <nowiki>[</nowiki>[[player]], ""];</code> | | |||
|x2= <code>_anyNearestLocation = [[nearestLocation]] <nowiki>[</nowiki>[[player]], ""];</code> |EXAMPLE2= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[ | | [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[Location#Location Types|Location Types]], [[locationPosition]], [[nearestLocations]], [[createLocation]] |SEEALSO= | ||
}} | }} | ||
Revision as of 00:26, 3 September 2019
Description
- Description:
- Return the closest location of specified class to a given position.
Checked range is unlimited (i.e. covers the whole map). - Groups:
- Uncategorised
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