nearestLocation: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (format pos) |
m (template:command argument fix) |
||
| Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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). |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''nearestLocation''' [position, locationClass] |= | | '''nearestLocation''' [position, locationClass] |SYNTAX= | ||
|p1= [position, locationClass]: [[Array]] |= | |p1= [position, locationClass]: [[Array]] |PARAMETER1= | ||
|p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |= | |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.|= | |p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned.|PARAMETER3= | ||
| [[Location]] |= | | [[Location]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_nearestCity = [[nearestLocation]] [ [[getPos]] [[player]], "nameCity"];</code> |= | |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> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[ArmA_2:_CfgLocationTypes]], [[locationPosition]], [[nearestLocations]], [[createLocation]] |= | | [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]], [[ArmA_2:_CfgLocationTypes]], [[locationPosition]], [[nearestLocations]], [[createLocation]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:44, 7 April 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.
- Return Value:
- Location
Examples
- Example 1:
_nearestCity = nearestLocation [ getPos player, "nameCity"];- Example 2:
_anyNearestLocation = nearestLocation [player, ""];
Additional Information
- See also:
- findNearestEnemynearestBuildingnearestObjectnearestObjectsnearObjectsnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoadsArmA_2:_CfgLocationTypeslocationPositionnearestLocationscreateLocation
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