BIS fnc selectRandomWeighted: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "{{Feature arma3|" to "{{Feature|arma3|") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma2 |Game name= | | arma2 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Arrays |GROUP1= | |gr1= Arrays |GROUP1= | ||
| 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: | ||
| Line 14: | Line 12: | ||
{{Feature|arma3|See [[selectRandomWeighted]] for an engine solution.}} |DESCRIPTION= | {{Feature|arma3|See [[selectRandomWeighted]] for an engine solution.}} |DESCRIPTION= | ||
| itemsAndWeights call [[BIS_fnc_selectRandomWeighted]] |SYNTAX= | | itemsAndWeights call [[BIS_fnc_selectRandomWeighted]] |SYNTAX= | ||
| Line 31: | Line 28: | ||
|r2= [[Anything]] |RETURNVALUE2= | |r2= [[Anything]] |RETURNVALUE2= | ||
|x1= <code>["apples",.3,"pears",.2,"bananas",.4,"diamonds",.1,"unicorns",.00001] [[call]] [[BIS_fnc_selectRandomWeighted]];</code> |Example1= | |x1= <code>["apples",.3,"pears",.2,"bananas",.4,"diamonds",.1,"unicorns",.00001] [[call]] [[BIS_fnc_selectRandomWeighted]];</code> |Example1= | ||
|x2= <code><nowiki>[</nowiki>["apples","pears","bananas","diamonds"],[0.3,0.2,0.4,0.1]] [[call]] [[BIS_fnc_selectRandomWeighted]];</code> |= | |x2= <code><nowiki>[</nowiki>["apples","pears","bananas","diamonds"],[0.3,0.2,0.4,0.1]] [[call]] [[BIS_fnc_selectRandomWeighted]];</code> |= | ||
| [[selectRandomWeighted]]|SEEALSO= | | [[selectRandomWeighted]]|SEEALSO= | ||
Revision as of 23:50, 16 January 2021
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:
- Arrays
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