distance
Revision as of 23:05, 19 June 2021 by Lou Montana (talk  contribs) (Text replacement  " \ *(game[09]version[09]gr[09]serverExecmpprdescrs[09]p[09]{1,3}r[09]x1?[09]seealso) *= +" to " $1= ")
Description
 Description:

Returns a distance in meters between Objects, Positions or Locations.
 Groups:
 Math  Geometry
Syntax
 Syntax:
 param1 distance param2
 Parameters:
 param1: Object or Array in format PositionAGL or Position2D
 param2: Object or Array in format PositionAGL or Position2D
 Return Value:
 Number  Distance in meters or 1e10 if distance cannot be calculated
Alternative Syntax
 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
Examples
 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"];
Additional Information
 See also:
 distanceSqrvectorDistancedistance2D
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
 Posted on Feb 14, 2007  12:00
 Sudden Death
 Distance to position3D (array) does not work with Operation Flashpoint, 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.
Categories:
 Scripting Commands
 Introduced with Operation Flashpoint version 1.00
 Operation Flashpoint: New Scripting Commands
 Operation Flashpoint: Scripting Commands
 Operation Flashpoint: Elite: Scripting Commands
 ArmA: Armed Assault: Scripting Commands
 Arma 2: Scripting Commands
 Arma 2: Operation Arrowhead: Scripting Commands
 Take On Helicopters: Scripting Commands
 Arma 3: Scripting Commands
 Command Group: Math  Geometry