distance2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3|Game name=
| arma3|Game name=
Line 9: Line 8:


|gr1= Math - Geometry |GROUP1=
|gr1= Math - Geometry |GROUP1=
____________________________________________________________________________________________


| Returns a 2D distance ([[distance]] projected to X,Y plane) in meters between two [[Object]]s or two [[Position]]s or [[Object]] and [[Position]].
| Returns a 2D distance ([[distance]] projected to X,Y plane) in meters between two [[Object]]s or two [[Position]]s or [[Object]] and [[Position]].
Line 15: Line 13:
[[Image:distance2D.jpg|400px]]
[[Image:distance2D.jpg|400px]]
|DESCRIPTION=
|DESCRIPTION=
____________________________________________________________________________________________


| param1 '''distance2D''' param2 |SYNTAX=
| param1 '''distance2D''' param2 |SYNTAX=
Line 23: Line 20:


| [[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
| [[Number]] -  Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
____________________________________________________________________________________________
    
    
|x1= <code>_meters = [[player]] [[distance2D]] heli;</code> |EXAMPLE1=
|x1= <code>_meters = [[player]] [[distance2D]] heli;</code> |EXAMPLE1=


____________________________________________________________________________________________


| [[distance]], [[distanceSqr]], [[vectorDistance]] |SEEALSO=
| [[distance]], [[distanceSqr]], [[vectorDistance]] |SEEALSO=

Revision as of 01:42, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns a 2D distance (distance projected to X,Y plane) in meters between two Objects or two Positions or Object and Position.

distance2D.jpg
Groups:
Math - Geometry

Syntax

Syntax:
param1 distance2D param2
Parameters:
param1: Object, Position2D or Position3D
param2: Object, Position2D or Position3D
Return Value:
Number - Distance in meters or 1e10 if distance cannot be calculated

Examples

Example 1:
_meters = player distance2D heli;

Additional Information

See also:
distancedistanceSqrvectorDistance

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

Bottom Section