distance: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Fix bad regex effects) Tag: Undo |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s. | | [[Image:distance2D.jpg|400px|right]] | ||
Returns a distance in meters between [[Object]]s, [[Position]]s or [[Location]]s. | |||
{{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]].}} | |||
|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 28: | Line 27: | ||
|p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER22= | |p22= location2: [[Location]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER22= | ||
|r2= | |r2= [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 34: | Line 33: | ||
|x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> |EXAMPLE2= | |x2= <code>_meters = [[player]] [[distance]] [1,2,3];</code> |EXAMPLE2= | ||
|x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> |EXAMPLE3= | |x3= <code>_meters = [1,2,3] [[distance]] [4,5,6];</code> |EXAMPLE3= | ||
|x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> | | |x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> |EXAMPLE4= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO= | | [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO= | ||
}} | }} | ||
| Line 69: | Line 66: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands OFP 1. | [[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP 1.96| | [[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP 1. | [[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Armed Assault| | |||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 19:49, 24 September 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.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- Scripting Commands Armed Assault
- Scripting Commands Arma 2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters