nearestLocations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Some wiki formatting)
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |Game name=
|game1= arma1
|version1= 1.08


|1.08|Game version=
|game2= arma2
|version2= 1.00


|arg= |Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|eff= |Multiplayer Effects=
|game4= tkoh
|version4= 1.00


|gr1= Locations |GROUP1=
|game5= arma3
|version5= 0.50


| Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
|gr1= Locations
{{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=
|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.}}


|p1= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER1=
|s1= [[nearestLocations]] [centre, locationTypes, radius, sortPosition]


|p2= locationTypeX: [[String]] - [[Location#Location Types|location type]] name, e.g "NameCity"
|p1= centre: [[Array]] format [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]]


|p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters.
|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


|p4= sortPosition: [[Array]] - (Optional) [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted from the distance to given ''sortPosition'' (nearest to farthest still) |PARAMETER4=
|p3= radius: [[Number]] - maximum distance from the given position that returned locations may be, in metres


| [[Array]] of [[Location|locations]] |RETURNVALUE=
|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)
 
|x1= <code>_nearbyLocations = [[nearestLocations]] [<nowiki/>[[position]] [[player]], ["RockArea", "VegetationFir"], 100];</code> |EXAMPLE1=


|x2= Find any of nearest locations:<code>[[private]] _allLocationTypes = [];
|r1= [[Array]] of [[Location]]s
"_allLocationTypes [[pushBack]] [[configName]] _x" [[configClasses]] ([[configFile]] >> "CfgLocationTypes");
 
|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]] [
systemChat format [
"%1 (%2) - %3m",  
"%1 (%2) - %3m",  
_x,  
_x,  
[[text]] _x,  
text _x,  
[[position]] [[player]] [[distance]] _x
getPosATL player distance _x
];
];
} [[forEach]] [[nearestLocations]] [<nowiki/>[[player]], _allLocationTypes, 500];</code>
} forEach nearestLocations [player, _allLocationTypes, 500];
</sqf>


| [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO=
|seealso= [[createLocation]] [[nearestLocation]] [[locationPosition]] [[nearestLocationWithDubbing]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 01:20, 6 September 2023

Logo A1 black.png1.08Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
ⓘ
Although locations can be placed in 3D with setPosition, nearestLocations' search result is sorted in 2D.
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"; Arma 3 logo black.png2.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:
_nearbyLocations = nearestLocations [getPosATL 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, getPosATL player distance _x ]; } forEach nearestLocations [player, _allLocationTypes, 500];

Additional Information

See also:
createLocation nearestLocation locationPosition nearestLocationWithDubbing

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
Retrieved from "https://community.bistudio.com/wiki?title=nearestLocations&oldid=347242"