nearestLocations: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
Line 6: | Line 6: | ||
|1.08|= Game version | |1.08|= Game version | ||
|arg= |= | |arg= |Multiplayer Arguments= | ||
|eff= |= | |eff= |Multiplayer Effects= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 11:12, 5 August 2019
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
- 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
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