Skip to content

Commit af3a4e0

Browse files
Document Set Sub-action Weight subaction (#370)
* Document Set Sub-action Weight subaction * Add version:1.0.0 tags to set-sub-action subactions * fix: formatting --------- Co-authored-by: Whipstickgostop <8366326+Whipstickgostop@users.noreply.github.com>
1 parent ab10df4 commit af3a4e0

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

streamerbot/3.api/1.sub-actions/core/actions/set-sub-action-state.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Set Sub-Action State
33
description: Enable or disable specific sub-actions within an action
4+
version: 1.0.0
45
parameters:
56
- name: Action
67
type: Select
@@ -24,4 +25,4 @@ parameters:
2425

2526
::read-more{to="/api/sub-actions/core/actions/set-action-state"}
2627
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
27-
::
28+
::
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Set Sub-Action Weight
3+
description: Changes the random weighting of specific sub-actions within an action
4+
version: 1.0.0
5+
parameters:
6+
- name: Action
7+
type: Select
8+
required: true
9+
description: Choose the parent action of the sub-action you wish to modify
10+
- name: Sub-Action
11+
type: Select
12+
required: true
13+
description: Choose the specific sub-action you wish to modify
14+
- name: Weight
15+
type: Number
16+
required: true
17+
description: |
18+
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.
19+
20+
For example, if all sub-action weights are the same, then they will all be equally likely to execute.
21+
22+
If one sub-action's weight is double another's, then that sub-action will be chosen twice as often.
23+
---
24+
25+
::tip
26+
Only applies to sub-actions of an Action or sub-action group that is set to Random.
27+
::

0 commit comments

Comments
 (0)