selectMin: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Undo revision 99152 by Killzone Kid (talk))
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(40 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


|arma3|= Game name
|game1= arma3
|version1= 1.66


|1.66|= Game version
|gr1= Arrays
____________________________________________________________________________________________


|Returns the array element with [[min]]imum numerical value. Engine solution to [[BIS_fnc_lowestNum]] and [[BIS_fnc_findExtreme]]. Therefore it is expected that supplied array consists of [[Number]]s only. However, [[Boolean]]s are also supported and will be converted to [[Number]]s: [[true]] <nowiki>=</nowiki>> 1, [[false]] <nowiki>=</nowiki>> 0. Other non [[Number]] elements (not recommended) will be converted to 0 but '''Bad conversion: scalar''' message will be logged into .[[rpt]].|= Description
|descr=Returns the array element with [[min]]imum numerical value. Engine solution to [[BIS_fnc_lowestNum]] 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.  
____________________________________________________________________________________________
{{Feature|warning|Other non [[Number]] elements (not recommended) will be evaluated as 0 and '''Bad conversion: scalar''' message will be logged into .[[rpt]].}}


|'''selectMin''' array |= Syntax
|s1= [[selectMin]] array


|p1= array: [[Array]] - array of [[Number]]s (see description)
|p1= array: [[Array]] - array of [[Number]]s


| [[Anything]] - element with [[min]]imum numerical value |= Return value
|r1= [[Anything]] - element with [[min]]imum numerical value
____________________________________________________________________________________________
 
 
|x1= <sqf>_min = selectMin [1,2,3,4,5]; //1</sqf>
|x1= <code>_min = [[selectMin]] [1,2,3,4,5]; //1</code> |= Example 1
|x2= <sqf>
|x2= <code>// Same as, for example:  
// Same as, for example:  
_min = _a [[min]] _b [[min]] _c [[min]] _d;
_min = _a min _b min _c min _d;
// Only faster:
// Only faster:
_min = [[selectMin]] [_a,_b,_c,_d];</code> |= Example 1
_min = selectMin [_a,_b,_c,_d];
____________________________________________________________________________________________
</sqf>
 
| [[selectMax]], [[min]], [[max]], [[selectRandom]], [[select]]|= See also


|seealso= [[selectMax]] [[min]] [[max]] [[selectRandom]] [[select]] [[selectRandomWeighted]]
}}
}}
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

Arma 3 logo black.png1.66
Hover & click on the images for description

Description

Description:
Returns the array element with minimum numerical value. Engine solution to BIS_fnc_lowestNum 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:
selectMin array
Parameters:
array: Array - array of Numbers
Return Value:
Anything - element with minimum numerical value

Examples

Example 1:
_min = selectMin [1,2,3,4,5]; //1
Example 2:
// Same as, for example: _min = _a min _b min _c min _d; // Only faster: _min = selectMin [_a,_b,_c,_d];

Additional Information

See also:
selectMax min max selectRandom select selectRandomWeighted

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
Retrieved from "https://community.bistudio.com/wiki?title=selectMin&oldid=369293"