nearestLocations

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Armed Assault version 1.08
  

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.08

Description

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

Syntax

Syntax:
nearestLocations [position, [locationType,...], radius, sortPosition]
Parameters:
[position, [locationType,...], radius, sortPosition]: Array
position: Array - Position2D, Position3D or Object
[locationType,...]: Array
locationType: String - location type name, e.g "NameCity"
radius: Number - maximum distance from the given position that returned locations may be, in meters.
sortPosition (Optional): Array - Position2D, Position3D or Object - results will be sorted: nearest location to given sortPosition first
Return Value:
Array of locations

Examples

Example 1:
_nearbyLocations = nearestLocations [position player, ["RockArea","VegetationFir"], 100];
Example 2:
Find any of nearest locations:allLocationTypes = []; "allLocationTypes pushBack configName _x" configClasses ( configFile >> "CfgLocationTypes" ); { systemChat format [ "%1 (%2) - %3m", _x, text _x, position player distance _x ]; } forEach nearestLocations [player, allLocationTypes, 500];

Additional Information

Multiplayer:
-
See also:
createLocationnearestLocationlocationPositionnearestLocationWithDubbing

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section