nearestLocations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(example)
Line 28: Line 28:
   
   
|x1= <code>_nearbyLocations = [[nearestLocations]] <nowiki>[</nowiki>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |= Example 1
|x1= <code>_nearbyLocations = [[nearestLocations]] <nowiki>[</nowiki>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |= Example 1
|x2= Find any of nearest locations:<code>allLocationTypes = [];
"allLocationTypes [[pushBack]] [[configName]] _x" [[configClasses]] (
[[configFile]] >> "CfgLocationTypes"
);
{
[[systemChat]] [[format]] [
"%1 (%2) - %3m",
_x,
[[text]] _x,
[[position]] [[player]] [[distance]] _x
];
} [[forEach]] [[nearestLocations]] <nowiki>[</nowiki>[[player]], allLocationTypes, 500];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 14:20, 26 July 2015

-wrong parameter ("Arma") defined!-1.08
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.
Groups:
Uncategorised

Syntax

Syntax:
nearestLocations [position, [locationType,...], radius, sortPosition]
Parameters:
[position, [locationType,...], radius, sortFrom]: Array
position: Array - Position2D, Position3D or Object
[locationType,...]: Array
locationType: String - location type name, e.g "NameCity"
radius: Number - maximum distance from the given position that returned locations may be, in meters.
sortPosition (Optional): Array - Position2D, Position3D or Object
Return Value:
Array of locations

Examples

Example 1:
_nearbyLocations = nearestLocations [position player, ["RockArea","VegetationFir"], 100];
Example 2:
Find any of nearest locations: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

Notes

Bottom Section