nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
m (Add link to location type) |
||
Line 19: | Line 19: | ||
|p2= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER2= | |p2= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER2= | ||
|p3= [locationType,...]: [[Array]] |PARAMETER3= | |p3= [locationType,...]: [[Array]] |PARAMETER3= | ||
|p4= locationType: [[String]] - location type name, e.g "NameCity" | |p4= locationType: [[String]] - [[Location#Location_Types|location type]] name, e.g "NameCity" | ||
|p5= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | |p5= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | ||
|p6= sortPosition (Optional): [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted: nearest location to given ''sortPosition'' first|PARAMETER4= | |p6= sortPosition (Optional): [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted: nearest location to given ''sortPosition'' first|PARAMETER4= |
Revision as of 10:45, 29 January 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