BIS fnc distance2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *D([a-z])" to "$1 - d$2")
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


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


| [param1, param2] call [[BIS_fnc_distance2D]] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]] |= Parameter 1
|gr1= Geometry


|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]] |= Parameter 2
|descr=Returns the distance between two [[Object|objects]] or [[Position|positions]].
{{Feature|arma3|Use [[distance2D]] instead.}}


| [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |RETURNVALUE=
|s1= [param1, param2] call [[BIS_fnc_distance2D]]
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]], rescueHelicopter] [[call]] [[BIS_fnc_distance2D]];</code> |= Example 1
|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
____________________________________________________________________________________________


| [[distance2D]], [[BIS_fnc_distance2Dsqr]] |SEEALSO=
|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Number]] - distance in meters or 1e10 if distance cannot be calculated
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>[player, rescueHelicopter] call BIS_fnc_distance2D;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[distance2D]] [[BIS_fnc_distance2Dsqr]]
[[Category:Function Group: Geometry|{{uc:distance2D}}]]
}}
[[Category:Functions|{{uc:distance2D}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:distance2D}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:distance2D}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:distance2D}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:distance2D}}]]

Latest revision as of 14:01, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
distance2D BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_distance2D&oldid=348503"