Core sub-actions

Clear action queue

Throws away the actions waiting in line in an action queue. Actions already running finish. Handy as an "emergency stop" button for a pile-up of alerts.

Setting	What to put in
Queue	The name of a queue from the Queues page, or All for every queue. Starts as: All.

Variables it adds

Variable	What it holds
%queueCleared%	How many waiting runs were thrown away

Type id: core.clearActionQueue

Comment

A note to yourself in the list of steps. It does nothing when the action runs. Good for explaining what a part of a long action is for.

Setting	What to put in
Comment	Your note, like "Greets new followers".
Colour	A color for the note in the editor, like #E0A030. Empty uses the normal color. It only changes how it looks.

Type id: core.comment

Delay

Waits before moving to the next step. 1000 milliseconds is 1 second. Good between a sound and a scene switch. It can also wait a random time.

Setting	What to put in
Milliseconds	How long to wait, in milliseconds. 1000 = 1 second, 5000 = 5 seconds. Starts as: 1000.
Random delay	Tick to wait a random time between the first number and the "To" number, instead of always the same time. Starts as: false.
To (milliseconds)	The longest wait, in milliseconds, when "Random delay" is ticked. With 1000 and 3000 it waits 1 to 3 seconds. Not used if unticked. Starts as: 2000.

Variables it adds

Variable	What it holds
%delayMs%	How many milliseconds it waited

Type id: core.delay

Get action group state

Checks an action group and tells you if all, none or some of its actions are turned on. The group is the "Group" box in an action's settings.

Setting	What to put in
Group	The group's name, as shown in your Actions list, like "Alerts".

Variables it adds

Variable	What it holds
%actionGroupState%	0 = all are off, 1 = all are on, 2 = some on and some off
%actionsEnabled%	A list with the ids of the actions that are on
%actionsDisabled%	A list with the ids of the actions that are off

Type id: core.getActionGroupState

Get action state

Finds out whether an action is turned on or off and keeps the answer in a variable. Pair it with an If step to act on the answer.

Setting	What to put in
Action	The action's name, exactly as in your Actions list.
Save in variable	The variable that receives the answer (true = on, false = off), without % signs. The default is actionEnabled. Starts as: actionEnabled.

Variables it adds

Variable	What it holds
%actionState%	True if the action is on, false if it is off

Type id: core.getActionState

Group

A folder for steps. Keeps a long action tidy. It can also run just ONE random step from inside, like picking one of five different thank-you messages.

Setting	What to put in
Name	A name for the group so you can see what is inside, like "Greetings". Only for you. Starts as: Group.
Run one random step	Tick to run only ONE step inside, picked at random, instead of all of them. Each step's weight makes it more or less likely. Starts as: false.
Colour	A color for the group in the editor, like #3A7BD5. Empty uses the normal color. It only changes how it looks.

Paths it can take: Steps.

Type id: core.group

Send local signal

Sends a secret message to other actions that are waiting with "Wait for local signal", which wakes them up. Handy to make one action wait for another.

Setting	What to put in
Signal name	A name you make up, like "go". The waiting step must use exactly the same name.
Include the action's variables	Tick to also hand over this action's %variables% to the action that wakes up. Starts as: false.
Values to send	Extra variables to hand over, one per line as name=value. Example: winner=%user%
Queue signal	Tick to keep the signal if nobody is waiting yet, so the next wait gets it. Unticked, it is lost if nobody is waiting. Starts as: false.

Variables it adds

Variable	What it holds
%signalWaiters%	How many waiting actions were woken up

Type id: core.sendSignal

Set action group state

Turns every action in an action group on or off, or flips each one. Handy to switch a whole set on together, like all your giveaway actions.

Setting	What to put in
Group	The group's name, as shown in your Actions list, like "Alerts".
State	Enable turns them on. Disable turns them off. Toggle flips each action to its opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setActionGroupState

Set action queue pause state

Pauses or resumes an action queue. While paused, actions wait in line instead of running. Good for holding alerts back during a serious moment.

Setting	What to put in
Queue	The name of a queue from the Queues page, or All for every queue. Starts as: All.
State	Pause holds actions back. Resume lets them run again. Toggle switches to the opposite. Options: Pause, Resume, Toggle. Starts as: Pause.
Also remove pending runs	Tick to also throw away the actions already waiting in line. Starts as: false.

Type id: core.setActionQueuePause

Set queue to one at a time

Switches the "blocking" option of an action queue. A blocking queue runs one action at a time, so the others wait their turn. The change is saved.

Setting	What to put in
Queue	The name of a queue from the Queues page. The Default queue cannot be changed.
Run one at a time	Enable = blocking on (one at a time). Disable = off (actions may overlap). Toggle = switch to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setActionQueueBlocking

Set sub-action weight

Changes how likely a step is to be picked when an action or group runs one random step. A bigger weight is picked more often. The change is saved.

Setting	What to put in
Action	The action's name, exactly as in your Actions list.
Sub-action	Which step: its number in the action (1 = the first; steps inside groups and branches are counted too) or its id.
Weight	How likely it is compared with the other steps. With weights 1 and 3, the second is picked three times as often. 0 = never. Starts as: 1.

Type id: core.setSubActionWeight

Trigger custom event

Sends out a custom event with a name you choose. Any action with a matching "Custom code event" trigger runs. A way to start several actions at once.

Setting	What to put in
Event name	A name you make up, like "party-time". The action that should run needs a Custom code event trigger with the same name.
Use variables	Tick to hand over this action's %variables% to the actions that start. Starts as: false.

Type id: core.triggerCustomEvent

Turn action on/off

Turns another action on or off, or flips it. A turned-off action ignores its triggers. Good for "only allow this while a giveaway runs". The change is saved.

Setting	What to put in
Action	The action's name, exactly as in your Actions list.
State	Enable turns it on. Disable turns it off. Toggle switches it to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setActionState

Turn sub-action on/off

Turns one single step of an action on or off, without opening the editor. A turned-off step is skipped when the action runs. The change is saved.

Setting	What to put in
Action	The action's name, exactly as in your Actions list.
Sub-action	Which step: its number in the action (1 = the first; steps inside groups and branches are counted too) or its id.
State	Enable turns it on. Disable turns it off. Toggle switches it to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setSubActionState

Turn trigger on/off

Turns one trigger of an action on or off, without opening the editor. A turned-off trigger no longer starts the action. The change is saved.

Setting	What to put in
Action	The action's name, exactly as in your Actions list.
Trigger	Which trigger: its number in the action's trigger list (1 = the first), its id, or its type name.
State	Enable turns it on. Disable turns it off. Toggle switches it to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setTriggerState

Wait for local signal

Pauses this action until another action sends the same signal. Good for waiting on a button press before going on. It can give up after a time limit.

Setting	What to put in
Signal name	The signal's name, exactly as in "Send local signal", like "go".
Timeout (ms, 0 = wait forever)	How long to wait before giving up, in milliseconds. 1000 = 1 second. 0 = wait forever. Starts as: 0.
Stop the action on timeout	Tick to stop the whole action if the wait runs out. Unticked, the action carries on with the next step. Starts as: false.
Overwrite variables	Tick so variables sent with the signal replace this action's variables with the same name. Unticked, yours are kept. Starts as: true.

Variables it adds

Variable	What it holds
%signalReceived%	True if the signal arrived
%signalTimeout%	True if the wait ran out first
%signalName%	The name of the signal that arrived
%hasResult%	True if the signal brought variables with it

Type id: core.waitForSignal

Write to log

Writes a line in Cuebot's log, which you can read to see what your actions do. Great for checking a %variable% while testing. Viewers never see it.

Setting	What to put in
Message	The text to write. You can use %variables%, like "Raid from %user%".
Level	How important it is: Debug (tiny detail), Info (normal), Warning (something odd), Error (something broke). Options: Debug, Info, Warning, Error. Starts as: Info.

Type id: core.log