distance: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 9: | Line 8: | ||
|gr1= Math - Geometry |GROUP1= | |gr1= Math - Geometry |GROUP1= | ||
| [[Image:distance2D.jpg|400px|right]] | | [[Image:distance2D.jpg|400px|right]] | ||
| Line 15: | Line 13: | ||
{{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]].}} | {{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= | |DESCRIPTION= | ||
| param1 '''distance''' param2 |SYNTAX= | | param1 '''distance''' param2 |SYNTAX= | ||
| Line 30: | Line 27: | ||
|r2= [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE2= | |r2= [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE2= | ||
|x1= <code>_meters = [[player]] [[distance]] _object;</code> |EXAMPLE1= | |x1= <code>_meters = [[player]] [[distance]] _object;</code> |EXAMPLE1= | ||
| Line 36: | Line 32: | ||
|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> |EXAMPLE4= | |x4= <code>_meters = [[position]] [[player]] [[distance]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "hill"];</code> |EXAMPLE4= | ||
| [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO= | | [[distanceSqr]], [[vectorDistance]], [[distance2D]] |SEEALSO= | ||
Revision as of 00:42, 17 January 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
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: Math - Geometry
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands