distance: Difference between revisions

Revision as of 02:12, 7 February 2021

Game1 needed - Version1 needed

Hover & click on the images for description

Description:: This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:: Math - Geometry

Syntax:: location1 distance location2
Parameters:: location1: Location or Array in format Position or Position2D
: location2: Location or Array in format Position or Position2D
Return Value:: Number - Distance in meters or 1e10 if distance cannot be calculated

Example 1:: _meters = player distance _object;
Example 2:: _meters = player distance [1,2,3];
Example 3:: _meters = [1,2,3] distance [4,5,6];
Example 4:: _meters = position player distance nearestLocation [position player, "hill"];

: 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

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.

@@ Line 11: / Line 11: @@
 | [[Image:distance2D.jpg|400px|right]]
 Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s.
-{{Important | If positions are supplied as arguments, the coordinates are treated as [[PositionATL]] if over the land and as [[PositionASLW]] if over the sea. If [[Position2D]] is supplied, z is assumed 0. If you need distance between two [[Position3D]] coordinates, use [[vectorDistance]].}}
+{{Feature | important | If positions are supplied as arguments, the coordinates are treated as [[PositionATL]] if over the land and as [[PositionASLW]] if over the sea. If [[Position2D]] is supplied, z is assumed 0. If you need distance between two [[Position3D]] coordinates, use [[vectorDistance]].}}
 | param1 '''distance''' param2