distance: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "") |
Lou Montana (talk | contribs) m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ") |
||
(12 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| ofp | |game1= ofp | ||
|version1= 1.00 | |||
|1.00 | |game2= ofpe | ||
|version2= 1.00 | |||
|game3= arma1 | |||
|version3= 1.00 | |||
|game4= arma2 | |||
|version4= 1.00 | |||
|game5= arma2oa | |||
|version5= 1.50 | |||
|game6= tkoh | |||
|version6= 1.00 | |||
|game7= arma3 | |||
|version7= 0.50 | |||
|arg= global | |arg= global | ||
Line 9: | Line 26: | ||
|gr1= Math - Geometry | |gr1= Math - Geometry | ||
| [[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 [[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]].}} | ||
|s1= param1 '''distance''' param2 | |||
| param1 | |p1= param1: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] | ||
|p2= param2: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] | |p2= param2: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] | ||
| [[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 | |||
| | |p21= location1: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] | ||
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] | |||
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[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> | ||
|x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> | |x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> | ||
|x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> | |x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> | ||
|x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> | |x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> | ||
| [[distanceSqr]], [[vectorDistance]], [[distance2D]] | |seealso= [[distanceSqr]], [[vectorDistance]], [[distance2D]] | ||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<dd class="notedate">Posted on Feb 14, 2007 - 12:00</dd> | |||
<dd class="notedate">Posted on Feb 14, 2007 - 12:00 | <dt class="note">[[User:Sudden Death|Sudden Death]]<dd class="note">Distance to position3D (array) doesnt work with {{ofp}}, only objects | ||
<dt class="note">[[User:Sudden Death|Sudden Death]]<dd class="note"> | |||
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 class="notedate">Posted on Mar 10, 2010 - 12:00</dd> | ||
<dt class="note">[[User:Rommel|Rommel]]<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. | <dt class="note">[[User:Rommel|Rommel]]<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. | ||
<dt><dt> | |||
<dd class="notedate">Posted on Aug 03, 2012 - 10:15 | <dd class="notedate">Posted on Aug 03, 2012 - 10:15</dd> | ||
<dt class="note">[[User:Ignoues01|Igneous01]]<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: | <dt class="note">[[User:Ignoues01|Igneous01]]<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: | ||
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 class="notedate">Posted on March 22, 2014</dd> | ||
<dt class="note">[[User:AgentRev01|AgentRev]]<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> | <dt class="note">[[User:AgentRev01|AgentRev]]<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> | ||
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> | </dl> | ||
{{GameCategory|arma1|Scripting Commands}} | {{GameCategory|arma1|Scripting Commands}} | ||
{{GameCategory|arma2|Scripting Commands}} | {{GameCategory|arma2|Scripting Commands}} | ||
{{GameCategory|arma3|Scripting Commands}} | {{GameCategory|arma3|Scripting Commands}} | ||
{{GameCategory|tkoh|Scripting Commands}} | {{GameCategory|tkoh|Scripting Commands}} |
Revision as of 15:56, 3 May 2021
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) doesnt 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