distance

1.00

GAGlobal

Hover & click on the images for description

Description

Description:

Returns the distance in meters between two Objects, Positions or (since VBS2 1.24) Locations.

NOTE: If positions are supplied as arguments, the coordinates are treated as PositionATL if over the land and as PositionASLW if over the sea.

Groups:

Uncategorised

Syntax

Syntax:

param1 distance param2

Parameters:

param1: Object, Location (since VBS2 1.24) or Array-format Position

param2: Object, Location (since VBS2 1.24) or Array-format Position

Return Value:

Number - Distance in meters.

Examples

Example 1:

_meters=player distance _object

Example 2:

_meters=player distance [1,2,3]

Example 3:

_meters=[1,2,3] distance player

Example 5:

_meters=[1,2,3] distance [4,5,6]

Additional Information

See also:

distanceSqr

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

Posted on Feb 14, 2007 - 12:00

Sudden Death

distance to position3D (array) doesnt work with OFP, only objects Armed Assault: position3D (array) and object works

Posted on Mar 10, 2010 - 12:00

Rommel

This returns the map distance, not the vector distance, [0,0,0] distance [0,0,1] can be >1 or <1, not exactly 1; unlike the vector math.

Posted on Aug 03, 2012 - 10:15

Igneous01

If a position in format [x, y, z] is provided for both arguments, distance also checks the z dimension as well. Ie: player distance [0,0,200] will return 200, if the player is at this position at ground/sea level.

Posted on March 22, 2014

AgentRev

When objects are supplied as arguments, distance is calculated from their model center (object modelToWorld [0,0,0]), and not the position returned by getPos/ATL/ASL.
However, this is not relevant for units, as their model center matches their world position.