BIS fnc selectRandomWeighted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|PARAMETER1= |p22=" to "|PARAMETER21= |p22=")
m (Text replacement - "|SYNTAX= |p21=" to "|SYNTAX2= |p21=")
Line 19: Line 19:
| [[Anything]] |RETURNVALUE=
| [[Anything]] |RETURNVALUE=


|s2= [items, weights] call [[BIS_fnc_selectRandomWeighted]] |SYNTAX=
|s2= [items, weights] call [[BIS_fnc_selectRandomWeighted]] |SYNTAX2=
 
|p21=[items, weights]: [[Array]]|PARAMETER21=
|p21=[items, weights]: [[Array]]|PARAMETER21=
|p22=items: [[Array]] - items array of [[Anything]] |PARAMETER1=
|p22=items: [[Array]] - items array of [[Anything]] |PARAMETER1=

Revision as of 02:00, 3 September 2019


Hover & click on the images for description

Description

Description:
Selects a random item from an array, taking into account item weight. Note:
  • The weights don't have to total to 1
  • The length of weights and items arrays may not match, in which case the shortest array is used for length
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
itemsAndWeights call BIS_fnc_selectRandomWeighted
Parameters:
itemsAndWeights: Array - array of items and weights [item, weight, item, weight...]
Return Value:
Anything

Alternative Syntax

Syntax:
[items, weights] call BIS_fnc_selectRandomWeighted
Parameters:
[items, weights]: Array
items: Array - items array of Anything
weights: Array - weights array of Numbers
Return Value:
Anything

Examples

Example 1:
["apples",.3,"pears",.2,"bananas",.4,"diamonds",.1,"unicorns",.00001] call BIS_fnc_selectRandomWeighted;
Example 2:
[["apples","pears","bananas","diamonds"],[0.3,0.2,0.4,0.1]] call BIS_fnc_selectRandomWeighted;

Additional Information

See also:
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

Notes

Bottom Section