BIS fnc getLineDist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "|= Game version" to "|Game version=")
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


//------------------
| [start1, length1, start2, length2] call [[BIS_fnc_getLineDist]] |SYNTAX=
// 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
//------------------


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


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= length1: [[Number]] - segment 1 length. Can be negative |PARAMETER2=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getLineDist]]; --> |= Syntax
|p3= start2: [[Number]] - segment 2 beginning. Can be negative |PARAMETER3=


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


| |= Return value
| [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>_distance = [0,5,15,20] [[call]] [[BIS_fnc_getLineDist]]; {{codecomment|// returns 10}}</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[distance]] |SEEALSO=
 
}}
}}


Revision as of 23:11, 30 August 2019

Logo A2.png1.00
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:
Uncategorised

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:
_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getLineDist&oldid=128476"