nearestTerrainObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(object types)
Line 12: Line 12:
''position'' can use the format:
''position'' can use the format:


<nowiki>[[</nowiki>x,y,z], ["Type",...], radius]
<tt><nowiki>[[</nowiki>x,y,z], ["Type",...], radius]</tt>


or
or


[object, ["Type",...], radius]
<tt>[object, ["Type",...], radius]</tt>




To use it without any type filter:
To use it without any type filter:


[object or position, [], radius].
<tt>[object or position, [], radius]</tt>
<br>
<br>
<br>
<br>
A list of Typenames can be found in [[Map_Symbols#Objects]]
Possible type names:<tt>"TREE", "SMALL TREE", "BUSH", "BUILDING", "HOUSE", "FOREST BORDER", "FOREST TRIANGLE", "FOREST SQUARE", "CHURCH", "CHAPEL", "CROSS", "ROCK", "BUNKER", "FORTRESS", "FOUNTAIN", "VIEW-TOWER", "LIGHTHOUSE", "QUAY", "FUELSTATION", "HOSPITAL", "FENCE", "WALL", "HIDE", "BUSSTOP", "ROAD", "FOREST", "TRANSMITTER", "STACK", "RUIN", "TOURISM", "WATERTOWER", "TRACK", "MAIN ROAD", "ROCKS", "POWER LINES", "RAILWAY", "POWERSOLAR", "POWERWAVE", "POWERWIND", "SHIPWRECK", "TRAIL"</tt>
|= Description
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 12:27, 23 February 2016

Hover & click on the images for description

Description

Description:
Returns a list of nearest terrain objects of the given types to the given position or object, within the specified distance. If more than one object is found they will be ordered according to distance2D to the object (i.e. the closest one will be first in the array). In contrast to nearestObjects this command returns terrain placed objects like trees, rocks and buildings which don't necessarily need an associated config class.

position can use the format: [[x,y,z], ["Type",...], radius] or [object, ["Type",...], radius] To use it without any type filter: [object or position, [], radius]

Possible type names:"TREE", "SMALL TREE", "BUSH", "BUILDING", "HOUSE", "FOREST BORDER", "FOREST TRIANGLE", "FOREST SQUARE", "CHURCH", "CHAPEL", "CROSS", "ROCK", "BUNKER", "FORTRESS", "FOUNTAIN", "VIEW-TOWER", "LIGHTHOUSE", "QUAY", "FUELSTATION", "HOSPITAL", "FENCE", "WALL", "HIDE", "BUSSTOP", "ROAD", "FOREST", "TRANSMITTER", "STACK", "RUIN", "TOURISM", "WATERTOWER", "TRACK", "MAIN ROAD", "ROCKS", "POWER LINES", "RAILWAY", "POWERSOLAR", "POWERWAVE", "POWERWIND", "SHIPWRECK", "TRAIL"
Groups:
Uncategorised

Syntax

Syntax:
nearestTerrainObjects [position, types, radius]
Parameters:
position: Object or Array in format PositionAGL or Position2D - where to find objects, center position.
types: Array - list of types of the objects to search for.
radius: Number - range from center position to search for objects.
Return Value:
Array - array of terrain objects sorted according to distance2D

Examples

Example 1:
nearestTerrainObjects [player, ["Tree","Bush"], 200];
Example 2:
nearestTerrainObjects [player, ["House"], 200];
Example 3:
nearestTerrainObjects [[2716,2949,0], ["Chapel","Fuelstation"], 100];
Example 4:
Return every terrain object in 50 metres radius around player:nearestTerrainObjects [player, [], 50]

Additional Information

See also:
findNearestEnemyhideObjectnearestBuildingnearestObjectnearObjectsnearestLocationnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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