selectMax: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
|arma3|Game name= | |arma3|Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Arrays |GROUP1= | |gr1= Arrays |GROUP1= | ||
|Returns the array element with [[max]]imum numerical value. Engine solution to [[BIS_fnc_greatestNum]] and [[BIS_fnc_findExtreme]]. Therefore it is expected that supplied array consists of [[Number]]s only. [[Boolean]]s however are also supported and will be evaluated as [[Number]]s: [[true]] - 1, [[false]] - 0. [[nil]] value treated as 0. | |Returns the array element with [[max]]imum numerical value. Engine solution to [[BIS_fnc_greatestNum]] and [[BIS_fnc_findExtreme]]. Therefore it is expected that supplied array consists of [[Number]]s only. [[Boolean]]s however are also supported and will be evaluated as [[Number]]s: [[true]] - 1, [[false]] - 0. [[nil]] value treated as 0. | ||
{{Warning | Other non [[Number]] elements (not recommended) will be evaluated as 0 and '''Bad conversion: scalar''' message will be logged into .[[rpt]].}}|DESCRIPTION= | {{Warning | Other non [[Number]] elements (not recommended) will be evaluated as 0 and '''Bad conversion: scalar''' message will be logged into .[[rpt]].}}|DESCRIPTION= | ||
|'''selectMax''' array |SYNTAX= | |'''selectMax''' array |SYNTAX= | ||
| Line 18: | Line 15: | ||
| [[Anything]] - element with [[max]]imum numerical value |RETURNVALUE= | | [[Anything]] - element with [[max]]imum numerical value |RETURNVALUE= | ||
|x1= <code>_max = [[selectMax]] [1,2,3,4,5]; //5</code> |EXAMPLE1= | |x1= <code>_max = [[selectMax]] [1,2,3,4,5]; //5</code> |EXAMPLE1= | ||
| Line 25: | Line 21: | ||
// Only faster: | // Only faster: | ||
_max = [[selectMax]] [_a,_b,_c,_d];</code> |EXAMPLE2= | _max = [[selectMax]] [_a,_b,_c,_d];</code> |EXAMPLE2= | ||
| [[selectMin]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]|SEEALSO= | | [[selectMin]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]|SEEALSO= | ||
Revision as of 03:35, 17 January 2021
Description
- Description:
- Returns the array element with maximum numerical value. Engine solution to BIS_fnc_greatestNum and BIS_fnc_findExtreme. Therefore it is expected that supplied array consists of Numbers only. Booleans however are also supported and will be evaluated as Numbers: true - 1, false - 0. nil value treated as 0.
- Groups:
- Arrays
Syntax
- Syntax:
- selectMax array
- Parameters:
- array: Array - array of Numbers
- Return Value:
- Anything - element with maximum numerical value
Examples
- Example 1:
_max = selectMax [1,2,3,4,5]; //5- Example 2:
// Same as, for example: _max = _a max _b max _c max _d; // Only faster: _max = selectMax [_a,_b,_c,_d];
Additional Information
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
- Posted on December 19, 2016 - 02:05 (UTC)
- Longbow
-
Returns either number or boolean value, in case max value in array 0, command will return either 0 or false, which ever comes first.
Same for 1 and true values.
selectMax [false,0] // returns false selectMax [0,false] // returns 0 selectMax [true,1] // returns true selectMax [1,true] // returns 1in case all values are equal or less than zero, command may also return other type of valuesselectMax ["",false,0,-1] // returns ""if nil value appears in array, other values are equal or less than zero, command returns nil