BIS fnc nearestNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - " \|seealso *= *([^ ]*)\[\[BIS fnc ([a-zA-Z0-9_]+)\]\]([^ ]*)" to " |seealso= $1BIS_fnc_$2$3")
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns the provided set closest number to the target number. |DESCRIPTION=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [values, value] call [[BIS_fnc_nearestNum]] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= values: [[Array]] of [[Number|Numbers]] - values to choose from |PARAMETER1=
|gr1= Arrays


|p2= value: [[Number]] - the reference value |PARAMETER2=
|gr2= Math


| [[Number]] - the closest value |RETURNVALUE=
|descr= Returns the provided set closest number to the target number.
____________________________________________________________________________________________


|x1= <code>_closestValueTo4 = <nowiki>[</nowiki>[1,5,10], 4] [[call]] [[BIS_fnc_nearestNum]]; {{codecomment|// returns 5}}</code> |EXAMPLE1=
|s1= [values, value] call [[BIS_fnc_nearestNum]]
____________________________________________________________________________________________


| [[BIS fnc randomNum]], [[random]] |SEEALSO=
|p1= values: [[Array]] of [[Number]]s - values to choose from
}}
 
|p2= value: [[Number]] - the reference value


<h3 style="display:none">Notes</h3>
|r1= [[Number]] - the closest value
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>private _closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_randomNum]] [[random]]
[[Category:Function Group: Numbers|{{uc:nearestNum}}]]
}}
[[Category:Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:nearestNum}}]]

Latest revision as of 18:02, 13 July 2022

Hover & click on the images for description

Description

Description:
Returns the provided set closest number to the target number.
Execution:
call
Groups:
ArraysMath

Syntax

Syntax:
[values, value] call BIS_fnc_nearestNum
Parameters:
values: Array of Numbers - values to choose from
value: Number - the reference value
Return Value:
Number - the closest value

Examples

Example 1:
private _closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5

Additional Information

See also:
BIS_fnc_randomNum random

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