nearestLocations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Text replacement - " \| *(\[\[[a-zA-Z0-9]+\]\][^ ]+) *\|x1=" to " |r1= $1 |x1=")
Line 20: Line 20:
|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]]
|r1= [[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>

Revision as of 14:22, 12 June 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:
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