nearestObject

1.00

Hover & click on the images for description

Description

Description:

Nearest object of given type to given position within a range of 50 meters. If object ID passed as an argument (as in example 2) the search range is unlimited. If class types are used in the filter, then in Arma any object derived from the type is found as well. In OFP, only objects with exactly the type given are found.

Groups:

Uncategorised

Syntax

Syntax:

nearestObject filter

Parameters:

filter: Array - Can be one of the following:
[x,y,z]: Any objects near position
[[x,y,z], "type"]: Objects of class "type" near position [x,y,z]
[object, "type"]: Objects of class "type" near position of "object"

Return Value:

Object - Found object, or objNull if nothing in range.

Alternative Syntax

Syntax:

position nearestObject filter

Parameters:

position: Array - Position3D.

filter: Number or String - Either ID of object, or class type.

Return Value:

Object - Found object, or objNull if nothing in range.

Examples

Example 1:

_nObject = nearestObject [2345,6789,0]; _nObject = nearestObject [player, "StreetLamp"];

Example 2:

Return the object with ID 123456:_nObject = [0,0,0] nearestObject 123456;

Example 3:

_nObject = getPos player nearestObject "StreetLamp";

Example 4:

Return the nearest object with (typeOf _nObject == "#XXXX") -> #mark, #slop, etc. Unlimited search range:_nObject = _position nearestObject -1; Return the nearest object with (typeOf _nObject != ""). Search range is 50m: _nObject = nearestObject _position;

Additional Information

See also:

nearestObjectsnearObjectsReadynearObjectsobjectFromNetIdnearEntitiesentitiesobject

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