nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(44 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma1 | | |game1= arma1 | ||
|version1= 1.08 | |||
|1. | |game2= arma2 | ||
|version2= 1.00 | |||
| | |game3= arma2oa | ||
|version3= 1.50 | |||
| | |game4= tkoh | ||
|version4= 1.00 | |||
| | |game5= arma3 | ||
|version5= 0.50 | |||
| | |gr1= Locations | ||
| [[ | |descr= Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. | ||
{{Feature|informative|Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]]' search result is sorted in 2D.}} | |||
| | |s1= [[nearestLocations]] [centre, locationTypes, radius, sortPosition] | ||
| | |p1= centre: [[Array]] format [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]] | ||
| | |p2= locationTypes: [[Array]] of [[String]]s - list of [[Location#Location Types|location type]] names, e.g "NameCity"; {{GVI|arma3|2.14|size= 0.75}} passing empty array [] will return all available locations within the radius | ||
| | |p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in metres | ||
| [[Array]] | |p4= sortPosition: [[Array]] format [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]] - (Optional) results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) | ||
|x2= Find any of nearest locations:< | |r1= [[Array]] of [[Location]]s | ||
"_allLocationTypes | |||
|x1= <sqf>_nearbyLocations = nearestLocations [getPosATL player, ["RockArea", "VegetationFir"], 100];</sqf> | |||
|x2= Find any of nearest locations: | |||
<sqf> | |||
private _allLocationTypes = []; | |||
"_allLocationTypes pushBack configName _x" configClasses (configFile >> "CfgLocationTypes"); | |||
{ | { | ||
systemChat format [ | |||
"%1 (%2) - %3m", | "%1 (%2) - %3m", | ||
_x, | _x, | ||
text _x, | |||
getPosATL player distance _x | |||
]; | ]; | ||
} | } forEach nearestLocations [player, _allLocationTypes, 500]; | ||
</sqf> | |||
| [[createLocation]] | |seealso= [[createLocation]] [[nearestLocation]] [[locationPosition]] [[nearestLocationWithDubbing]] | ||
}} | }} | ||
Latest revision as of 01:20, 6 September 2023
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 [centre, locationTypes, radius, sortPosition]
- Parameters:
- centre: Array format Position2D, Position3D or Object
- locationTypes: Array of Strings - list of location type names, e.g "NameCity"; 2.14 passing empty array [] will return all available locations within the radius
- radius: Number - maximum distance from the given position that returned locations may be, in metres
- sortPosition: Array format Position2D, Position3D or Object - (Optional) results will be sorted from the distance to given sortPosition (nearest to farthest still)
- Return Value:
- Array of Locations
Examples
- Example 1:
- Example 2:
- Find any of nearest locations:
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
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.08
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Locations