nearestLocations: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (description) |
m (template:command argument fix) |
||
| Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''nearestLocations''' [position, [locationType,...], radius, sortPosition] |= | | '''nearestLocations''' [position, [locationType,...], radius, sortPosition] |SYNTAX= | ||
|p1= [position, [locationType,...], radius, sortPosition]: [[Array]] |= | |p1= [position, [locationType,...], radius, sortPosition]: [[Array]] |PARAMETER1= | ||
|p2= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |= | |p2= position: [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER2= | ||
|p3= [locationType,...]: [[Array]] |= | |p3= [locationType,...]: [[Array]] |PARAMETER3= | ||
|p4= locationType: [[String]] - location type name, e.g "NameCity" | |p4= locationType: [[String]] - location type name, e.g "NameCity" | ||
|p5= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | |p5= radius: [[Number]] - maximum distance from the given position that returned locations may be, in meters. | ||
|p6= sortPosition (Optional): [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted: nearest location to given ''sortPosition'' first|= | |p6= sortPosition (Optional): [[Array]] - [[Position2D]], [[Position3D]] or [[Object]] - results will be sorted: nearest location to given ''sortPosition'' first|PARAMETER4= | ||
| [[Array]] of [[Location|locations]] |= | | [[Array]] of [[Location|locations]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_nearbyLocations = [[nearestLocations]] <nowiki>[</nowiki>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |= | |x1= <code>_nearbyLocations = [[nearestLocations]] <nowiki>[</nowiki>[[position]] [[player]], ["RockArea","VegetationFir"], 100];</code> |EXAMPLE1= | ||
|x2= Find any of nearest locations:<code>allLocationTypes = []; | |x2= Find any of nearest locations:<code>allLocationTypes = []; | ||
| Line 43: | Line 43: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |= | | [[createLocation]], [[nearestLocation]], [[locationPosition]], [[nearestLocationWithDubbing]] |SEEALSO= | ||
}} | }} | ||
Revision as of 15:44, 7 April 2019
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, sortPosition]: 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 - results will be sorted: nearest location to given sortPosition first
- 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
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