BIS fnc roundDir: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Round direction to nearest set rounding; used for determining cardinal direction. |= Description
____________________________________________________________________________________________


Description:
| [rawDirection, rounding] call [[BIS_fnc_roundDir]] |= Syntax
Round direction to nearest limit
(used for determining cardinal direction)


Parameter(s):
|p1= rawDirection: [[Number]] - direction to round |= Parameter 1
_this select 0: NUMBER - direction
_this select 1 (Optional): NUMBER - limit direction (default: 90)


Returns:
|p2= rounding: [[Number]] - (Optional, default 90) - rounding value. With 90° possible return values are 0, 90, 180 and 270. |= Parameter 2
NUMBER - rounded direction
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Number]] - rounded direction, depending on input '''can be negative or over 360''' |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_roundDir]]; --> |= Syntax
|x1= <code>[[player]] [[setDir]] (<nowiki>[</nowiki>[[getDir]] [[player]], 45] [[call]] [[BIS_fnc_roundDir]]);</code> |= Example 1


|p1= |= Parameter 1
|x2= <code>[204.2, 10] [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 200}}</code> |= Example 2


| |= Return value
|x3= <code>[271, 180] [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 360}}</code> |= Example 3
____________________________________________________________________________________________


|x1= <code></code> |=  
|x4= <code>70 [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 90}}</code> |= Example 4
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[setDir]], [[getRelDir]], [[round]] |= See also
 
}}
}}



Revision as of 00:19, 3 May 2018

Hover & click on the images for description

Description

Description:
Round direction to nearest set rounding; used for determining cardinal direction.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[rawDirection, rounding] call BIS_fnc_roundDir
Parameters:
rawDirection: Number - direction to round
rounding: Number - (Optional, default 90) - rounding value. With 90° possible return values are 0, 90, 180 and 270.
Return Value:
Number - rounded direction, depending on input can be negative or over 360

Examples

Example 1:
player setDir ([getDir player, 45] call BIS_fnc_roundDir);
Example 2:
[204.2, 10] call BIS_fnc_roundDir; // will return 200
Example 3:
[271, 180] call BIS_fnc_roundDir; // will return 360
Example 4:
70 call BIS_fnc_roundDir; // will return 90

Additional Information

See also:
setDirgetRelDirround

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