diff --git a/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-state.md b/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-state.md index fe16c216..acddfe36 100644 --- a/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-state.md +++ b/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-state.md @@ -1,6 +1,7 @@ --- title: Set Sub-Action State description: Enable or disable specific sub-actions within an action +version: 1.0.0 parameters: - name: Action type: Select @@ -24,4 +25,4 @@ parameters: ::read-more{to="/api/sub-actions/core/actions/set-action-state"} To modify the state of an entire action, and all sub-actions, see the [Set Action State](/api/sub-actions/core/actions/set-action-state) sub-action -:: \ No newline at end of file +:: diff --git a/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-weight.md b/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-weight.md new file mode 100644 index 00000000..0e426336 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-weight.md @@ -0,0 +1,27 @@ +--- +title: Set Sub-Action Weight +description: Changes the random weighting of specific sub-actions within an action +version: 1.0.0 +parameters: + - name: Action + type: Select + required: true + description: Choose the parent action of the sub-action you wish to modify + - name: Sub-Action + type: Select + required: true + description: Choose the specific sub-action you wish to modify + - name: Weight + type: Number + required: true + description: | + Sets the new "weight" for the selected sub-action, which is the probability, relative to the other sub-actions' weights, that the sub-action will be chosen. + + For example, if all sub-action weights are the same, then they will all be equally likely to execute. + + If one sub-action's weight is double another's, then that sub-action will be chosen twice as often. +--- + +::tip +Only applies to sub-actions of an Action or sub-action group that is set to Random. +::