BIS fnc getLineDist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "BIS fnc " to "BIS_fnc_")
 
(33 intermediate revisions by 4 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


| <pre>
|game4= arma3
|version4= 0.50


//------------------
|gr1= Geometry
// Purpose: This function returns the distance between two sections of a straight line
// Arguments: [start section 1, length section 1, start section 2, length section 2]
// Return: float
//
// Revision History:
// 10/11/06 0.1 - First cut
//------------------


|descr= Return the distance between two sections of a virtual straight line.<br>
<br>
[[File:BIS_fnc_getLineDistSchema.png]]


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [start1, length1, start2, length2] call [[BIS_fnc_getLineDist]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getLineDist]]; --> |= Syntax
|p1= start1: [[Number]] - segment 1 beginning. Can be negative


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


| |= Return value
|p3= start2: [[Number]] - segment 2 beginning. Can be negative
____________________________________________________________________________________________


|x1= <code></code> |=
|p4= length2: [[Number]] - segment 2 length. Can be negative
____________________________________________________________________________________________


| |= See also
|r1= [[Number]]


|x1= <sqf>private _distance = [0,5,15,20] call BIS_fnc_getLineDist; // returns 10</sqf>
|seealso= [[distance]]
}}
}}
<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: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