The Wheel Overlay Widget allows you to display a spin wheel that shows a set of options, spin to one randomly, and trigger the associated command for that outcome. This can be useful for things like a prize selection, determining a specific thing a streamer has to do, or providing a chance odds for a good / bad effect that could happen to the user that spun the wheel.
The wheel can be spun by using the Spin Wheel option on the Overlay Action inside of a command.
Each option on a wheel is known as an outcome and each outcome has a probability for how likely it is to occur. There are two ways that probabilities can be set for outcome:
- Equal Probability: This is used by enabling the "Equal Probability For Outcomes" option. Each outcome added will have the same probability of occurring. You do not need to set any probability amount as it will be dynamically computed based on the total number of outcomes. For example, if there are 4 outcomes, each one will have a 25% chance of occurring (100% / 4).
- Set Probability: This is used by disabling the "Equal Probability For Outcomes" option. Each outcome's probability must be manually specified, with the total amount having to equal 100%. Decimal values are supported for percentages (EX: 1.2%).
Outcomes can have a dedicated color set for them or a color will be randomly choosen for them based on the name of the outcome.
Outcomes can also have a dedicated command assigned to them for when they occur. If the command for the outcome has no actions in it, the Default Outcome command will be triggered instead.
¶ Outcome Probability Modifiers
When using set probabilities for outcomes, you additionally have the ability to specify modifiers to each outcome that will be added / subtracted to the outcome. This allow you to make certain outcomes more or less likely to occur with subsequent spins. The total sum of all modifiers must equal 0.
Positive modifiers will make an outcome more likely to occur, while negative modifiers will make an outcome less likely to occur. If an outcome picked by the wheel has a negative modifier, all modifiers will be applied to every outcome to change their chance of occurring. If an outcome picked by the wheel has a positive modifier, all outcome probabilities will be reset to their starting amounts. For example, let's say you had the following outcome setup:
- Big Prize with 10% probability and a 10 modifier
- Medium Prize with 30% probability and a 0 modifier
- Small Prize with 60% with a -10 modifier
Let's say the wheel is spun and it lands on Small Prize. Because Small Prize has a negative modifier, all the probabilities will have their modifiers applied to them, making the new probabilities be:
- Big Prize: 10% + 10 = 20%
- Medium Prize: 30% + 0 = 30%
- Small Prize: 60% - 10 = 50%
Now let's say the wheel is spun and it lands on Medium Prize. Because Medium Prize has a 0 modifier, no changes are made to any of the probabilities.
Now let's say the wheel is spun and it lands on Big Prize. Because Big Prize has a positive modifier, all probabilities are reset back to their initial starting points:
- Big Prize: 10%
- Medium Prize: 30%
- Small Prize: 60%
¶ Outcome Commands
Besides the Default Outcome command, each outcome can have it's own dedicated command that can be triggered. If an outcome has a command and it has at least 1 action in it, that outcome's command will be triggered when it lands on it. If an outcome does not have a command or it has no actions in it, then the Default Outcome command will be triggered instead. Both commands have access to the following Special Identifiers:
- $outcomename = The name of the outcome that was selected