nearestLocation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(example)
(format pos)
Line 17: Line 17:


|p1= [position, locationClass]: [[Array]] |= Parameter 1
|p1= [position, locationClass]: [[Array]] |= Parameter 1
|p2= position: [[Position2D]], [[Position3D]] or [[Object]] |= Parameter 2
|p2= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |= Parameter 2
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned.|= Parameter 3
|p3= locationClass: [[String]] of a location class name. If "" is supplied, any nearest location is returned.|= Parameter 3



Revision as of 13:54, 27 September 2015

-wrong parameter ("Arma") defined!-1.08
Hover & click on the images for description

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

Notes

Bottom Section