nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|") |
Lou Montana (talk | contribs) (Add 2D search info) |
||
| Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest. |DESCRIPTION= | | 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.}} |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition] |SYNTAX= | ||
|p1 | |p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER1= | ||
|p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity" | |||
|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) |PARAMETER4= | |||
| [[Array]] of [[Location|locations]] |RETURNVALUE= | | [[Array]] of [[Location|locations]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |EXAMPLE1= | |x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> |EXAMPLE1= | ||
|x2= Find any of nearest locations:<code> | |x2= Find any of nearest locations:<code>[[private]] _allLocationTypes = []; | ||
" | "_allLocationTypes[[pushBack]] [[configName]] _x" [[configClasses]] ([[configFile]] >> "CfgLocationTypes"); | ||
); | |||
{ | { | ||
[[systemChat]] [[format]] [ | [[systemChat]] [[format]] [ | ||
| Line 40: | Line 39: | ||
[[position]] [[player]] [[distance]] _x | [[position]] [[player]] [[distance]] _x | ||
]; | ]; | ||
} [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], | } [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO= | | [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO= | ||
}} | }} | ||
| Line 56: | Line 54: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command Group: Locations|{{uc:{{PAGENAME}}}}]] | |||
Revision as of 23:08, 13 July 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, [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 = []; "_allLocationTypespushBack 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