BIS fnc nearestNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1 = Arrays |GROUP1=
|gr1 = Arrays


|gr2 = Math |GROUP2=
|gr2 = Math


| Returns the provided set closest number to the target number. |DESCRIPTION=
| Returns the provided set closest number to the target number.


| [values, value] call [[BIS_fnc_nearestNum]] |SYNTAX=
| [values, value] call [[BIS_fnc_nearestNum]]


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


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


| [[Number]] - the closest value |RETURNVALUE=
| [[Number]] - the closest value


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


| [[BIS fnc randomNum]], [[random]] |SEEALSO=
| [[BIS fnc randomNum]], [[random]]
}}
}}



Revision as of 00:40, 18 January 2021

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:
_closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5

Additional Information

See also:
BIS fnc randomNumrandom

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

Bottom Section