BIS fnc roundNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(35 intermediate revisions by 3 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
File: fn_roundNum.sqf


Description:
|gr1= Math
Round a number to the provided factor.


Parameter(s):
|descr=Round a number to the provided factor.
_this select 0: number (Scalar)
_this select 1: factor (Scalar)
_this select 2: (optional) secondary factor, used when number / primary factor is smaller than 10 (Scalar)
Returns:
Scalar - rounded number
*/


//Validate parameter count
|s1= [number, factor, secondary factor] call [[BIS_fnc_roundNum]]
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_roundNum]]; --> |= Syntax
|p1= number: [[Number]] - number that should be rounded.


|p1= |= Parameter 1
|p2= factor: [[Number]] - factor


| |= Return value
|p3= secondary factor: [[Number]] - (optional) Secondary factor, used when number / primary factor is smaller than 10 (scalar).
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Number]] - rounded number
____________________________________________________________________________________________


| |= See also
|x1= <sqf>[10.254,2,3] call BIS_fnc_roundNum;//Returns 9</sqf>
|x2= <sqf>[10.254,1,3] call BIS_fnc_roundNum;//Returns 10</sqf>


|seealso= [[BIS_fnc_randomInt]] [[BIS_fnc_geometricMean]] [[BIS_fnc_arithmeticMean]] [[BIS_fnc_nearestNum]] [[BIS_fnc_sortNum]]
}}
}}
<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: Numbers|{{uc:roundNum}}]]
[[Category:Functions|{{uc:roundNum}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:roundNum}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:roundNum}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:roundNum}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:roundNum}}]]

Latest revision as of 16:47, 8 November 2023

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

Description

Description:
Round a number to the provided factor.
Execution:
call
Groups:
Math

Syntax

Syntax:
[number, factor, secondary factor] call BIS_fnc_roundNum
Parameters:
number: Number - number that should be rounded.
factor: Number - factor
secondary factor: Number - (optional) Secondary factor, used when number / primary factor is smaller than 10 (scalar).
Return Value:
Number - rounded number

Examples

Example 1:
[10.254,2,3] call BIS_fnc_roundNum;//Returns 9
Example 2:
[10.254,1,3] call BIS_fnc_roundNum;//Returns 10

Additional Information

See also:
BIS_fnc_randomInt BIS_fnc_geometricMean BIS_fnc_arithmeticMean BIS_fnc_nearestNum BIS_fnc_sortNum

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_roundNum&oldid=349030"