nearestLocations: Difference between revisions
Jump to navigation
Jump to search
m (Add link to location type) |
Lou Montana (talk | contribs) m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>") |
||
| Line 27: | Line 27: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_nearbyLocations = [[nearestLocations]] <nowiki | |x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |EXAMPLE1= | ||
|x2= Find any of nearest locations:<code>allLocationTypes = []; | |x2= Find any of nearest locations:<code>allLocationTypes = []; | ||
| Line 40: | Line 40: | ||
[[position]] [[player]] [[distance]] _x | [[position]] [[player]] [[distance]] _x | ||
]; | ]; | ||
} [[forEach]] [[nearestLocations]] <nowiki | } [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], allLocationTypes, 500];</code> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 14:05, 19 March 2020
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