nearestLocations: Difference between revisions

Revision as of 23:42, 23 January 2009

-wrong parameter ("Arma") defined!-1.08

Hover & click on the images for description

Description:: Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
Groups:: Uncategorised

Syntax:: Array = nearestLocations [position, [locationType,...], radius]
Parameters:: [position, [locationType,...], radius]: Array
: position: Array - format Position
: [locationType,...]: Array An array of location type name strings
: radius: Number The maximum distance from the given position that returned locations may be, in meters.
Return Value:: Array of locations

Example 1:

_nearbyLocations = nearestLocations [getPos player, ["RockArea","VegetationFir"], 100]

: 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

@@ Line 14: / Line 14: @@
 ____________________________________________________________________________________________
-| [[Array]] <nowiki>=</nowiki> '''nearestLocations''' <nowiki>[</nowiki>[[Position]] , <nowiki>["LocationType",...]</nowiki>, radius] |= Syntax
+| [[Array]] <nowiki>=</nowiki> '''nearestLocations''' [position, [locationType,...], radius] |= Syntax
-|p1= [[Position]] |= Parameter 1
+|p1= [position, [locationType,...], radius]: [[Array]] |= Parameter 1
-|p2= <nowiki>["LocationType",...]</nowiki> <nowiki>=</nowiki> An array of location type name [[String|strings]] |= Parameter 2
+|p2= position: [[Array]] - format [[Position]] |= Parameter 2
-|p3= radius <nowiki>=</nowiki> The maximum distance from the given position that returned locations may be, in meters. |= Parameter 3
+|p3= [locationType,...]: [[Array]] An array of location type name [[String|strings]] |= Parameter 3
+|p4= radius: [[Number]] The maximum distance from the given position that returned locations may be, in meters. |= Parameter 4