BIS fnc roundNum: 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
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


| <pre>
|Round a number to the provided factor.|= Description
/*
____________________________________________________________________________________________
File: fn_roundNum.sqf
 
Description:
Round a number to the provided factor.


Parameter(s):
|[number, factor, secondary factor] call '''BIS_fnc_roundNum'''|= Syntax
_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
|p1= number: [[Number]] - Number that should be rounded.|= Parameter 1
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_roundNum]]; --> |= Syntax
|p2= factor: [[Number]] - Factor (Scalar).|= Parameter 2


|p1= |= Parameter 1
|p3= secondary factor: [[Number]] - (optional) Secondary factor (Scalar), used when number / primary factor is smaller than 10 (scalar).|= Parameter 3


| |= Return value
|[[Scalar]] - Rounded number|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[10.254,2,3] [[call]] '''BIS_fnc_roundNum''';//Returns 9</code> |= Example 1
|x2= <code>[10.254,1,3] [[call]] '''BIS_fnc_roundNum''';//Returns 10</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|[[BIS_fnc_randomInt]] [[BIS_fnc_geometricMean]] [[BIS_fnc_arithmeticMean]] [[BIS_fnc_nearestNum]] [[BIS_fnc_sortNum]]|= See also
}}


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 16:02, 26 April 2018

Logo A2.png1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
[number, factor, secondary factor] call BIS_fnc_roundNum
Parameters:
number: Number - Number that should be rounded.
factor: Number - Factor (Scalar).
secondary factor: Number - (optional) Secondary factor (Scalar), used when number / primary factor is smaller than 10 (scalar).
Return Value:
Scalar - 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


Notes

Bottom Section

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