BIS fnc selectRandomWeighted: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Fix bad regex effects) |
||
| Line 9: | Line 9: | ||
| Selects a random item from an array, taking into account item weight. Note: | | Selects a random item from an array, taking into account item weight. Note: | ||
* The weights don't have to total to 1 | * 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|DESCRIPTION= | * The length of weights and items arrays may not match, in which case the shortest array is used for length | ||
{{Feature arma3|See [[selectRandomWeighted]] for an engine solution.}} |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| itemsAndWeights call [[BIS_fnc_selectRandomWeighted]] |SYNTAX= | | itemsAndWeights call [[BIS_fnc_selectRandomWeighted]] |SYNTAX= | ||
|p1=itemsAndWeights: [[Array]] - array of items and weights [item, weight, item, weight...]|PARAMETER1= | |p1=itemsAndWeights: [[Array]] - array of items and weights [item, weight, item, weight...] |PARAMETER1= | ||
| [[Anything]] |RETURNVALUE= | | [[Anything]] |RETURNVALUE= | ||
| Line 21: | Line 23: | ||
|p21=[items, weights]: [[Array]]|PARAMETER21= | |p21=[items, weights]: [[Array]]|PARAMETER21= | ||
|p22=|PARAMETER22= | |||
|p22=items: [[Array]] - items array of [[Anything]] |PARAMETER22= | |||
|p23=weights: [[Array]] - weights array of [[Number]]s |PARAMETER23= | |p23=weights: [[Array]] - weights array of [[Number]]s |PARAMETER23= | ||
| Line 44: | Line 48: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Function Group: Arrays|{{uc:selectRandomWeighted}}]] | [[Category:Function Group: Arrays|{{uc:selectRandomWeighted}}]] | ||
[[Category:{{Name|arma2oa}}: Functions|{{uc:selectRandomWeighted}}]] | [[Category:{{Name|arma2oa}}: Functions|{{uc:selectRandomWeighted}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:selectRandomWeighted}}]] | |||
[[Category:{{Name|tkoh}}: Functions|{{uc:selectRandomWeighted}}]] | [[Category:{{Name|tkoh}}: Functions|{{uc:selectRandomWeighted}}]] | ||
Revision as of 02:27, 25 September 2020
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
See selectRandomWeighted for an engine solution. - 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