BIS fnc distance2D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(populated the page)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *D([a-z])" to "$1 - d$2")
 
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Arma 2 version of [[distance2D]].<br />
|game4= arma3
Use [[distance2D]] instead if available as Arma 3's BIS_fnc_distance2D uses [[distance2D]] internally anyway<br />
|version4= 0.50
<pre>
/************************************************************
Distance 2D


Parameters: [object or position 1, object or position 2]
|gr1= Geometry


Returns the distance between the two objects or positions
|descr=Returns the distance between two [[Object|objects]] or [[Position|positions]].
"as the crow flies" (ignoring elevation)
{{Feature|arma3|Use [[distance2D]] instead.}}
Example: [player, getpos dude] call BIS_fnc_distance2D
************************************************************/


//return squared distance between _pos1 and _pos2
|s1= [param1, param2] call [[BIS_fnc_distance2D]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| [param1, param2] call '''BIS_fnc_distance2D''' |= Syntax
|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]


|p1= param1: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]]|= Parameter 1
|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position#Introduction|Position2D]]
|p2= param2: [[Object]] or [[Array]] in format [[Position]] or [[Position2D]]|= Parameter 2


| [[Number]] - Distance in meters or 1e10 if distance cannot be calculated |= Return value
|r1= [[Number]] - distance in meters or 1e10 if distance cannot be calculated
____________________________________________________________________________________________


|x1= <code> [player, rescueHelicopter] call BIS_fnc_distance2D </code> |=
|x1= <sqf>[player, rescueHelicopter] call BIS_fnc_distance2D;</sqf>
____________________________________________________________________________________________
 
| [[distance2D]] |= See also


|seealso= [[distance2D]] [[BIS_fnc_distance2Dsqr]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[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"