distance: Difference between revisions
Jump to navigation
Jump to search
Sudden Death (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|") |
||
(47 intermediate revisions by 16 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| ofp | | | ofp |Game name= | ||
|1.00| | |1.00|Game version= | ||
|arg= global |= | |arg= global |Multiplayer Arguments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns | | Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s. | ||
<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> | |||
[[Image:distance2D.jpg|400px]]|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | param1 '''distance''' param2 |SYNTAX= | ||
|p1= param1: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER1= | |||
|p2= param2: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER2= | |||
| [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE= | |||
| | | s2= location1 '''distance''' location2 |SYNTAX2= | ||
| | |p21= location1: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER21= | ||
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER2= | |||
| [[Number]] - | | r2=[[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE= | ||
Distance in meters | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code> | |x1= <code>_meters = [[player]] [[distance]] _object;</code> |EXAMPLE1= | ||
|x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> |EXAMPLE2= | |||
|x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> |EXAMPLE3= | |||
|x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> |EXAMPLE5=4 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO= | ||
}} | }} | ||
Line 33: | Line 46: | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
distance to position3D doesnt work with OFP, only objects | <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 | |||
Armed Assault: | Armed Assault: | ||
position3D and object works | position3D (array) and object works | ||
<dd class="notedate">Posted on Mar 10, 2010 - 12:00 | |||
<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. | |||
<dd class="notedate">Posted on Aug 03, 2012 - 10:15 | |||
<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] | |||
will return 200, if the player is at this position at ground/sea level. | |||
<dd class="notedate">Posted on March 22, 2014 | |||
<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. | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
Line 43: | Line 70: | ||
[[Category:Scripting Commands|DISTANCE]] | [[Category:Scripting Commands|DISTANCE]] | ||
[[Category:Scripting Commands OFP 1.99|DISTANCE]] | |||
[[Category:Scripting Commands OFP 1.96|DISTANCE]] | [[Category:Scripting Commands OFP 1.96|DISTANCE]] | ||
[[Category:Scripting Commands OFP 1.46|DISTANCE]] | [[Category:Scripting Commands OFP 1.46|DISTANCE]] | ||
[[Category:Scripting Commands | [[Category:Scripting Commands Armed Assault|DISTANCE]] | ||
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] |
Revision as of 20:18, 3 June 2020
Description
- Description:
- Returns a distance in meters between Objects, Positions or Locations.
- Groups:
- Uncategorised
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
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands Armed Assault
- Command Group: Object Information
- Scripting Commands Arma 2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters