BIS fnc getLineDist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "BIS fnc " to "BIS_fnc_")
 
(29 intermediate revisions by 2 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


| Return the distance between two sections of a virtual straight line.<br />
|game3= tkoh
<br />
|version3= 1.00
[[File:BIS fnc getLineDistSchema.png]] |DESCRIPTION=
____________________________________________________________________________________________


| [start1, length1, start2, length2] call [[BIS_fnc_getLineDist]] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= start1: [[Number]] - segment 1 beginning. Can be negative |PARAMETER1=
|gr1= Geometry


|p2= length1: [[Number]] - segment 1 length. Can be negative |PARAMETER2=
|descr= Return the distance between two sections of a virtual straight line.<br>
<br>
[[File:BIS_fnc_getLineDistSchema.png]]


|p3= start2: [[Number]] - segment 2 beginning. Can be negative |PARAMETER3=
|s1= [start1, length1, start2, length2] call [[BIS_fnc_getLineDist]]


|p4= length2: [[Number]] - segment 2 length. Can be negative |PARAMETER4=
|p1= start1: [[Number]] - segment 1 beginning. Can be negative


| [[Number]] |RETURNVALUE=
|p2= length1: [[Number]] - segment 1 length. Can be negative
____________________________________________________________________________________________


|x1= <code>_distance = [0,5,15,20] [[call]] [[BIS_fnc_getLineDist]]; {{codecomment|// returns 10}}</code> |EXAMPLE1=
|p3= start2: [[Number]] - segment 2 beginning. Can be negative
____________________________________________________________________________________________


| [[distance]] |SEEALSO=
|p4= length2: [[Number]] - segment 2 length. Can be negative
}}


<h3 style="display:none">Notes</h3>
|r1= [[Number]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>private _distance = [0,5,15,20] call BIS_fnc_getLineDist; // returns 10</sqf>
</dl>


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

Latest revision as of 12:15, 27 July 2022

Hover & click on the images for description

Description

Description:
Return the distance between two sections of a virtual straight line.

BIS fnc getLineDistSchema.png
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[start1, length1, start2, length2] call BIS_fnc_getLineDist
Parameters:
start1: Number - segment 1 beginning. Can be negative
length1: Number - segment 1 length. Can be negative
start2: Number - segment 2 beginning. Can be negative
length2: Number - segment 2 length. Can be negative
Return Value:
Number

Examples

Example 1:
private _distance = [0,5,15,20] call BIS_fnc_getLineDist; // returns 10

Additional Information

See also:
distance

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