distance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(clarification added)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the distance in meters between two [[Object]]s, [[Position]]s or (since VBS2 1.24) [[Location]]s. |= Description
| Returns the distance in meters between two [[Object]]s, [[Position]]s or (since VBS2 1.24) [[Location]]s.
 
<br/><br/>'''NOTE:''' If positions are supplied as arguments, the coordinates are treated as [[PositionATL]] if over land and as [[PositionASLW]] if over sea.|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 17:46, 14 February 2014

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 land and as PositionASLW if over sea.
Groups:
Uncategorised

Syntax

Syntax:
var1 distance var2
Parameters:
var1: Object, Location (since VBS2 1.24) or Array-format Position
var2 or pos2: 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.

Bottom Section