BIS fnc randomIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "\|s1= +" to "|s1= ")
(30 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/************************************************************
|version4= 0.50
Random Index


Parameters: array
|gr1= Arrays


This returns a random integer representing an index in the passed array.
|descr= Return a random integer representing an index in the passed array.


Example: [1,2,3] call BIS_fnc_selectRandom
|s1= array call [[BIS_fnc_randomIndex]]
Returns: 0, 1, or 2
************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= array: [[Array]] of [[Anything]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_randomIndex]]; --> |= Syntax
|r1= [[Number]]


|p1= |= Parameter 1
|x1= <code>["a",0,objNull] [[call]] [[BIS_fnc_randomIndex]]; {{codecomment|// returns 0, 1 or 2}}</code>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[floor]], [[count]], [[random]], [[selectRandom]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:randomIndex}}]]
[[Category:Functions|{{uc:randomIndex}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:randomIndex}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:randomIndex}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:randomIndex}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:randomIndex}}]]

Revision as of 16:31, 19 June 2021

Hover & click on the images for description

Description

Description:
Return a random integer representing an index in the passed array.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
array call BIS_fnc_randomIndex
Parameters:
array: Array of Anything
Return Value:
Number

Examples

Example 1:
["a",0,objNull] call BIS_fnc_randomIndex; // returns 0, 1 or 2

Additional Information

See also:
floorcountrandomselectRandom

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