nearestLocation: Difference between revisions
Killzone Kid (talk | contribs) (accepts object as position) |
Killzone Kid (talk | contribs) (example) |
||
| Line 18: | Line 18: | ||
|p1= [position, locationClass]: [[Array]] |= Parameter 1 | |p1= [position, locationClass]: [[Array]] |= Parameter 1 | ||
|p2= position: [[Position2D]], [[Position3D]] or [[Object]] |= Parameter 2 | |p2= position: [[Position2D]], [[Position3D]] or [[Object]] |= Parameter 2 | ||
|p3= locationClass: [[String]] of a location class name.|= Parameter 3 | |p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned.|= Parameter 3 | ||
| [[Location]] |= Return value | | [[Location]] |= Return value | ||
| Line 24: | Line 24: | ||
|x1= <code>_nearestCity = [[nearestLocation]] [ [[getPos]] [[player]], "nameCity"];</code> |= Example 1 | |x1= <code>_nearestCity = [[nearestLocation]] [ [[getPos]] [[player]], "nameCity"];</code> |= Example 1 | ||
|x2= <code>_anyNearestLocation = [[nearestLocation]] <nowiki>[</nowiki>[[player]], ""];</code> |= Example 1 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 13:26, 26 July 2015
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: Position2D, Position3D or Object
- 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