nearestLocations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|")
Line 12: Line 12:


| 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.}}
{{Feature | 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]

Revision as of 00:11, 7 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Locations

Syntax

Syntax:
Syntax needed
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:
Return value needed

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:
See also needed

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