nearestObjects

From Bohemia Interactive Community

Jump to: navigation, search
Editors, please check Policy: Scripting Command Page Syntax.
Introduced in Armed Assault version 1.00

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

Description

Description:
Returns a list of nearest objects of the given types to the given position or object, within the specified distance.

Pos can use the format:

[[x,y,z], ["ClassName",...], radius]

or

[object, ["ClassName",...], radius].

A list of ClassName types (Tanks eg) can be found in CfgVehicles

If more than one object is found they will be ordered according to their distance (i.e. the closest one will be first in the array).

Syntax

Syntax:

  • Array = nearestObjects [ Position, ["ClassName",...], radius].
  • Array = nearestObjects [ Object, ["ClassName",...], radius].

Source array can be a simple array or an array of arrays.

Parameters:
Classname: String

This is the classname of the object or objects to be searched for, this can be a single classname, an array of classnames, or an empty array to return all the objects within it's radius (including classless WRP placed objects such as trees).

radius: Number Max radius in meters within which the object is searched for.
Return Value:
Array

Examples

Example 1:
nearestObjects [player, ["Car","Tank"], 200]
Example 2:
nearestObjects [player, ["house"], 200]
Example 3:
nearestObjects [[2716,2949,0], ["Car","Truck"], 100]

Additional Information

Multiplayer:
Behaviour unknown.
See also:
nearestObject, nearestObject type, nearObjects, nearestObject id

Notes

Notes

+ Add Note

Only post proven facts here. Use the talk page or the forums for discussions.

Notes

Bottom Section

Personal tools
Buy ArmA now!