nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\|= * " to " ") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma1 | | arma1 | ||
|1.08 | |1.08 | ||
|arg | |arg= | ||
|eff | |eff= | ||
|gr1= Locations | |gr1= Locations | ||
| Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. | | Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. | ||
{{Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} | {{Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}} | ||
| [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] | | [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] | ||
|p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] | |p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] | ||
|p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity" | |p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity" | ||
| Line 22: | Line 22: | ||
|p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | |p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | ||
|p4= sortPosition: [[Array]] - (Optional) [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) | |p4= sortPosition: [[Array]] - (Optional) [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) | ||
| [[Array]] of [[Location|locations]] | | [[Array]] of [[Location|locations]] | ||
|x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> | |x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> | ||
|x2= Find any of nearest locations:<code>[[private]] _allLocationTypes = []; | |x2= Find any of nearest locations:<code>[[private]] _allLocationTypes = []; | ||
| Line 39: | Line 39: | ||
} [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code> | } [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code> | ||
| [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] | | [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] | ||
}} | }} | ||
Revision as of 01:23, 18 January 2021
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:
- Locations
Syntax
- Syntax:
- nearestLocations [position, [locationType1, locationType2, ...], radius, sortPosition]
- Parameters:
- position: Array - Position2D, Position3D or Object
- locationTypeX: String - location type name, e.g "NameCity"
- radius: Number - maximum distance from the given position that returned locations may be, in meters.
- sortPosition: Array - (Optional) Position2D, Position3D or Object - results will be sorted from the distance to given sortPosition (nearest to farthest still)
- Return Value:
- Array of locations
Examples
- Example 1:
_nearbyLocations = nearestLocations [position player, ["RockArea", "VegetationFir"], 100];- Example 2:
- Find any of nearest locations:
private _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