BIS fnc distance2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1 = Geometry |GROUP1=
|gr1 = Geometry


|Returns the distance between two [[Object|objects]] or [[Position|positions]].
|Returns the distance between two [[Object|objects]] or [[Position|positions]].
{{Feature|arma3|Use [[distance2D]] instead.}}
{{Feature|arma3|Use [[distance2D]] instead.}}
|DESCRIPTION=


| [param1, param2] call [[BIS_fnc_distance2D]] |SYNTAX=


|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER1=
| [param1, param2] call [[BIS_fnc_distance2D]]


|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]] |PARAMETER2=
|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]]


| [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]]


|x1= <code><nowiki>[</nowiki>[[player]], rescueHelicopter] [[call]] [[BIS_fnc_distance2D]];</code> |EXAMPLE1=
| [[Number]] - Distance in meters or 1e10 if distance cannot be calculated


| [[distance2D]], [[BIS_fnc_distance2Dsqr]] |SEEALSO=
|x1= <code><nowiki>[</nowiki>[[player]], rescueHelicopter] [[call]] [[BIS_fnc_distance2D]];</code>
 
| [[distance2D]], [[BIS_fnc_distance2Dsqr]]
}}
}}



Revision as of 00:02, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns the distance between two objects or positions.
Arma 3
Use distance2D instead.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[param1, param2] call BIS_fnc_distance2D
Parameters:
param1: Object or Array in format Position or Position2D
param2: Object or Array in format Position or Position2D
Return Value:
Number - Distance in meters or 1e10 if distance cannot be calculated

Examples

Example 1:
[player, rescueHelicopter] call BIS_fnc_distance2D;

Additional Information

See also:
distance2DBIS_fnc_distance2Dsqr

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


Bottom Section