nearestLocations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| arma1 \|1.([0-9]{2}) \|([^g]|g[^a])" to "| arma1 |1.$1 |game2= arma2 |version2= 1.00 |game3= arma2oa |version3= 1.50 |game4= tkoh |version4= 1.00 |game5= arma3 |version5= 0.50 |$2")
m (Text replacement - " \| *(([^=\| ]+)('''|\[\[)([^=\| ]+)) * +\|p1=" to " |s1= $1 |p1=")
Line 21: Line 21:
{{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}}
{{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search result is sorted in 2D.}}


| [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition]
|s1=  [[nearestLocations]] [position, [locationType1, locationType2, ...], radius, sortPosition]


|p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]]
|p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]]

Revision as of 23:15, 12 June 2021

Hover & click on the images for description

Description

Description:
Description needed
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

See also:
createLocationnearestLocationlocationPositionnearestLocationWithDubbing

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