BIS fnc roundDir: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| tkoh |= Game name
|game1= tkoh
|version1= 1.00


|1.00|= Game version
|game2= arma3
____________________________________________________________________________________________
|version2= 0.50


| Round direction to nearest set rounding; used for determining cardinal direction. |DESCRIPTION=
|gr1= Math
____________________________________________________________________________________________


| [rawDirection, rounding] call [[BIS_fnc_roundDir]] |SYNTAX=
|descr= Round direction to nearest set rounding; used for determining cardinal direction.


|p1= rawDirection: [[Number]] - direction to round |PARAMETER1=
|s1= [rawDirection, rounding] call [[BIS_fnc_roundDir]]


|p2= rounding: [[Number]] - (Optional, default 90) - rounding value. With 90° possible return values are 0, 90, 180 and 270. |PARAMETER2=
|p1= rawDirection: [[Number]] - direction to round


| [[Number]] - rounded direction, depending on input '''can be negative or over 360''' |RETURNVALUE=
|p2= rounding: [[Number]] - (Optional, default 90) - rounding value. With 90° possible return values are 0, 90, 180 and 270
____________________________________________________________________________________________


|x1= <code>[[player]] [[setDir]] (<nowiki>[</nowiki>[[getDir]] [[player]], 45] [[call]] [[BIS_fnc_roundDir]]);</code> |EXAMPLE1=
|r1= [[Number]] - rounded direction, depending on input. '''Can be negative or over 360'''


|x2= <code>[204.2, 10] [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 200}}</code> |EXAMPLE2=
|x1= <sqf>player setDir ([getDir player, 45] call BIS_fnc_roundDir);</sqf>


|x3= <code>[271, 180] [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 360}}</code> |EXAMPLE3=
|x2= <sqf>[204.2, 10] call BIS_fnc_roundDir; // will return 200</sqf>


|x4= <code>70 [[call]] [[BIS_fnc_roundDir]]; {{codecomment|// will return 90}}</code> |EXAMPLE4=
|x3= <sqf>[271, 180] call BIS_fnc_roundDir; // will return 360</sqf>
____________________________________________________________________________________________


| [[setDir]], [[getRelDir]], [[round]] |SEEALSO=
|x4= <sqf>70 call BIS_fnc_roundDir; // will return 90</sqf>
 
|seealso= [[setDir]] [[getRelDir]] [[round]]
}}
}}
<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: Misc|{{uc:roundDir}}]]
[[Category:Functions|{{uc:roundDir}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:roundDir}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:roundDir}}]]

Latest revision as of 14:12, 13 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

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

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:
setDir getRelDir round

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_roundDir&oldid=327918"