Arma 3 Scripting

Command in Object Detection

nearestTerrainObjects

Also available as Markdown and JSON, or read the original wiki page.

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 3D distance 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.

Possible type names:

Important

The names are / The filter is based on the named property map - not on the named property class or any config definition!

Note

Types which are missing are not present in the given world. Virtual Reality has no terrain objects. Last updated Arma 3 v2.12

Stratis

Altis

Malden 2035

Tanoa

Livonia

Weferlingen

Weferlingen (Winter)

Cam Lao Nam

Khe Sanh

The Bra

Gabreta

Sefrou-Ramal

Spearhead 1944 Normandy

Spearhead 1944 Mortain

Syntax

nearestTerrainObjects [position, types, radius, sort, 2Dmode]

Parameters:

Returns: Array of Objects - Before Arma 3 v2.00 this command did not return roads of type "ROAD", "MAIN ROAD", "TRACK", "TRAIL"

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 sorted, closest first:

nearestTerrainObjects [player, [], 50];

Example 5

Return every terrain object in 50 metres radius around player unsorted:

nearestTerrainObjects [player, [], 50, false];

Example 6

Hide all terrain objects (run locally for each client):

private _allTerrainObjects = nearestTerrainObjects
[
    [worldSize / 2, worldSize / 2],
    [],
    worldSize * sqrt 2 / 2,
    false,
    true
];
{ _x hideObject true } forEach _allTerrainObjects;

See also

nearestObjects · findNearestEnemy · hideObject · nearestBuilding · nearestObject · nearObjects · nearestLocation · nearEntities · nearTargets · nearSupplies · nearestLocationWithDubbing · nearObjectsReady · nearRoads · roadsConnectedTo · roadAt · isOnRoad · getRoadInfo · nearestMines

Community notes

Killzone_Kid

Since Arma 3 v1.66 the default sorting is done according to 3D distance not distance2D as before. This is an attempt to correct some very old bug in implementation.

Demellion

Be aware that some terrain objects types might be tricky to be found, such as terrain rocks and boulders which are not considered to be "ROCKS" or "ROCK", but "HIDE". Example:

nearestTerrainObjects [player, ["HIDE"], 20]; // [939688: bluntstone_01.p3d,939691: garbagebags_f.p3d,939671: wreck_car_f.p3d,939692: junkpile_f.p3d]
Killzone_Kid

Large bridges are map type "ROAD". Small foot bridges are not roads and not included into road net.