selectMax: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


|arma3|Game name=
|arma3


|1.66|Game version=
|1.66


|gr1= Arrays |GROUP1=
|gr1= Arrays


|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]].}}


|'''selectMax''' array |SYNTAX=
|'''selectMax''' array


|p1= array: [[Array]] - array of [[Number]]s |PARAMETER1=
|p1= array: [[Array]] - array of [[Number]]s


| [[Anything]] - element with [[max]]imum numerical value |RETURNVALUE=
| [[Anything]] - element with [[max]]imum numerical value
   
   
|x1= <code>_max = [[selectMax]] [1,2,3,4,5]; //5</code> |EXAMPLE1=
|x1= <code>_max = [[selectMax]] [1,2,3,4,5]; //5</code>
|x2= <code>// Same as, for example:  
|x2= <code>// Same as, for example:  
_max = _a [[max]] _b [[max]] _c [[max]] _d;
_max = _a [[max]] _b [[max]] _c [[max]] _d;
// Only faster:
// Only faster:
_max = [[selectMax]] [_a,_b,_c,_d];</code> |EXAMPLE2=
_max = [[selectMax]] [_a,_b,_c,_d];</code>


| [[selectMin]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]|SEEALSO=
| [[selectMin]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]


}}
}}

Revision as of 12:01, 18 January 2021

Hover & click on the images for description

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.
Other non Number elements (not recommended) will be evaluated as 0 and Bad conversion: scalar message will be logged into .rpt.
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

See also:
selectMinminmaxselectRandomselectselectRandomWeighted

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 1 in case all values are equal or less than zero, command may also return other type of values selectMax ["",false,0,-1] // returns "" if nil value appears in array, other values are equal or less than zero, command returns nil