Difference between revisions of "distance"

From Bohemia Interactive Community
Jump to navigation Jump to search
(note see also)
m (template:command argument fix)
Line 13: Line 13:
 
<br/><br/>{{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]]}}  
 
<br/><br/>{{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]]}}  
 
<br><br>
 
<br><br>
[[Image:distance2D.jpg|400px]]|= Description
+
[[Image:distance2D.jpg|400px]]|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| param1 '''distance''' param2 |= Syntax
+
| param1 '''distance''' param2 |SYNTAX=
  
|p1= param1: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |= Parameter 1
+
|p1= param1: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER1=
|p2= param2: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |= Parameter 2
+
|p2= param2: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER2=
  
| [[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |= Return value
+
| [[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
  
| s2= location1 '''distance''' location2 |= Syntax
+
| s2= location1 '''distance''' location2 |SYNTAX=
  
|p21=  location1: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |= Parameter 1
+
|p21=  location1: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER1=
|p22=  location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |= Parameter 2
+
|p22=  location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER2=
  
| r2=[[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |= Return value
+
| r2=[[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
    
 
    
|x1= <code>_meters = [[player]] [[distance]] _object;</code> |= Example 1
+
|x1= <code>_meters = [[player]] [[distance]] _object;</code> |EXAMPLE1=
|x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> |= Example 2
+
|x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> |EXAMPLE2=
|x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> |= Example 3
+
|x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> |EXAMPLE3=
|x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "hill"];</code> |= Example 54
+
|x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "hill"];</code> |EXAMPLE5=4
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[distanceSqr]], [[vectorDistance]], [[distance2D]] |= See also
+
| [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO=
  
 
}}
 
}}

Revision as of 15:38, 7 April 2019

Template:Command

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.

Bottom Section