distance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Position2D" to "Position2D")
m (Some wiki formatting)
Line 28: Line 28:
|descr= [[Image:distance2D.jpg|400px|right]]
|descr= [[Image:distance2D.jpg|400px|right]]
Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s.
Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s.
{{Feature | important | If positions are supplied as arguments, the coordinates are treated as [[Position#PositionAGL|PositionAGL]]. If [[Position#Introduction|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 [[Position#PositionAGL|PositionAGL]]. If [[Position#Introduction|Position2D]] is supplied, z is assumed 0. If you need distance between two [[Position#Position3D|Position3D]] coordinates, use [[vectorDistance]].}}


|s1= param1 [[distance]] param2
|s1= param1 [[distance]] param2


|p1= param1: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]
|p1= param1: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]
Line 36: Line 36:
|p2= param2: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]
|p2= param2: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]]


|r1= [[Number]] - Distance in meters or 1e10 if distance cannot be calculated
|r1= [[Number]] - distance in meters or 1e10 if distance cannot be calculated


|s2= location1 [[distance]] location2
|s2= location1 [[distance]] location2


|p21= location1: [[Location]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
|p21= location1: [[Location]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
Line 44: Line 44:
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]


|r2= [[Number]] - Distance in meters or 1e10 if distance cannot be calculated
|r2= [[Number]] - distance in meters or 1e10 if distance cannot be calculated
    
    
|x1= <code>_meters = [[player]] [[distance]] _object;</code>
|x1= <code>_meters = [[player]] [[distance]] _object;</code>
Line 57: Line 57:
}}
}}


<dl class="command_description">
{{Note
 
|user= Sudden Death
<dd class="notedate">Posted on Feb 14, 2007 - 12:00</dd>
|timestamp= 20070214164700
<dt class="note">[[User:Sudden Death|Sudden Death]]</dt>
|text= Distance to position3D (array) does not work with {{ofp}}, only objects
<dd class="note">Distance to position3D (array) does not work with {{ofp}}, only objects


Armed Assault:
Armed Assault:
position3D (array) and object works
position3D (array) and object works
<dt><dt>
}}
<dd class="notedate">Posted on Mar 10, 2010 - 12:00</dd>
 
<dt class="note">[[User:Rommel|Rommel]]</dt>
{{Note
<dd class="note">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.
|user= Rommel
<dt><dt>
|timestamp= 20100310075400
<dd class="notedate">Posted on Aug 03, 2012 - 10:15</dd>
|text= 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.
<dt class="note">[[User:Ignoues01|Igneous01]]</dt>
}}
<dd class="note">If a position in format [x, y, z] is provided for both arguments, distance also checks the z dimension as well. Ie:
 
{{Note
|user= Igneous01
|timestamp= 20120803101500
|text= 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]
player distance [0,0,200]
will return 200, if the player is at this position at ground/sea level.
will return 200, if the player is at this position at ground/sea level.
<dt><dt>
}}
<dd class="notedate">Posted on March 22, 2014</dd>
 
<dt class="note">[[User:AgentRev01|AgentRev]]</dt>
{{Note
<dd class="note">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.<br>
|user= AgentRev01
|timestamp= 20140323025200
|text= 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.<br>
However, this is not relevant for units, as their model center matches their world position.
However, this is not relevant for units, as their model center matches their world position.
 
}}
</dl>

Revision as of 17:10, 5 January 2022

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
distance2D.jpg

Returns a distance in meters between Objects, Positions or Locations.

⚠
If positions are supplied as arguments, the coordinates are treated as PositionAGL. If Position2D is supplied, z is assumed 0. If you need distance between two Position3D coordinates, use vectorDistance.
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
Sudden Death - c
Posted on Feb 14, 2007 - 16:47 (UTC)
Distance to position3D (array) does not work with Operation Flashpoint, only objects Armed Assault: position3D (array) and object works
Rommel - c
Posted on Mar 10, 2010 - 07:54 (UTC)
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.
Igneous01 - c
Posted on Aug 03, 2012 - 10:15 (UTC)
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.
AgentRev01 - c
Posted on Mar 23, 2014 - 02:52 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=distance&oldid=296868"