BIS fnc randomIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Some wiki formatting)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Return a random integer representing an index in the passed array. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| array call [[BIS_fnc_randomIndex]] |= Syntax
|game4= arma3
|version4= 0.50


|p1= array: [[Array]] of [[Anything]] |= Parameter 1
|gr1= Arrays


| [[Number]] |= Return value
|descr= Return a random integer representing an index in the passed array.
____________________________________________________________________________________________


|x1= <code>["a",0,objNull] [[call]] [[BIS_fnc_randomIndex]]; {{codecomment|// returns 0, 1 or 2}}</code> |= Example 1
|s1= array call [[BIS_fnc_randomIndex]]
____________________________________________________________________________________________


| [[floor]], [[count]], [[random]], [[selectRandom]] |= See also
|p1= array: [[Array]] of [[Anything]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Number]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>["a", 0, objNull] call BIS_fnc_randomIndex; // returns 0, 1 or 2</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[floor]] [[count]] [[random]] [[selectRandom]]
[[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}}]]

Latest revision as of 23:07, 12 July 2022

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:
floor count random selectRandom

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