Variables sub-actions

Clear temporary global variables

Deletes all global variables that are not kept after a restart. Variables you kept are not touched. Good for a fresh start at the beginning of a stream.

Type id: core.clearTemporaryGlobals

Clear temporary user variables

Deletes the viewer variables that are not kept after a restart, for everyone. Kept ones stay. Good for a fresh start, like resetting a quiz.

Setting	What to put in
Platform	Only clear for viewers on this site, like twitch. Empty = all sites.

Type id: core.clearTemporaryUserVariables

Delete global variable

Deletes a global variable, so it is gone. Good to reset something like a counter completely.

Setting	What to put in
Variable name	The variable's name without the ~ signs, like "deaths".

Type id: core.deleteGlobal

Delete user variable

Deletes a variable that belongs to one viewer, or to every viewer. Good to reset something like a quiz score.

Setting	What to put in
Variable name	The variable's name, like "score".
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User id	The viewer's id on their site. Empty = the viewer who started the action, or the one found by user name.
User name	The viewer's chat name, like "kris". Used to find the viewer when you give no id.
For all users	Tick to delete it from every viewer of that site (all sites if Platform is empty), not just one. Starts as: false.

Type id: core.deleteUserVariable

Get global variable

Reads a global variable and puts its value in a normal variable you can use with %name%. Needed when you want to check a remembered value, like a death count.

Setting	What to put in
Variable name	The global variable's name without the ~ signs, like "deaths".
Save in variable	The variable that receives the value, without % signs. Empty = same name as the global variable.
Default value	The value to use if the global variable does not exist yet. Empty = leave the variable unset.
Auto type	Tick so numbers stay real numbers (needed for greater/less than checks). Normally leave it ticked. Starts as: true.

Type id: core.getGlobal

Get user variable

Reads a variable that belongs to one viewer, like their score, and puts the value in a normal variable you can use with %name%.

Setting	What to put in
Variable name	The viewer variable's name, like "score".
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User id	The viewer's id on their site. Empty = the viewer who started the action, or the one found by user name.
User name	The viewer's chat name, like "kris". Used to find the viewer when you give no id.
Save in variable	The variable that receives the value, without % signs. Empty = same name as the viewer variable.
Default value	The value to use if the viewer or variable does not exist. Empty = leave the variable unset.
Auto type	Tick so numbers stay real numbers (needed for greater/less than checks). Normally leave it ticked. Starts as: true.

Type id: core.getUserVariable

Pick color

Picks a color and saves it in several formats for other steps, like OBS or a light. Pick the color while editing, run it, then use %color.html% and friends.

Setting	What to put in
Color	The color as hex digits: #RRGGBB, like #FF9146, or #AARRGGBB when you want see-through (alpha). Starts as: #FF9146FF.
Variable name	A name for the result variables, without %. With "color" you get %color.html% and the others. Starts as: color.

Variables it adds

Variable	What it holds
%color.html%	The color as #RRGGBB (name is the one you chose)
%color.htmlalpha%	The color as #AARRGGBB, including see-through
%color.obs%	The color as a number in the format OBS expects
%color.color.r%	The red part, 0 to 255 (g = green, b = blue, a = see-through)

Type id: core.pickColor

Random number

Picks a random number, like rolling a dice, and saves it in a variable. Good for "roll 1 to 100" commands or a chance for something to happen.

Setting	What to put in
Type	Between = a whole number from Minimum to Maximum. Next Float = a number from 0 to 1, plus a percent from 0 to 100. Options: Between, Next Float. Starts as: Between.
Save in variable	The variable that gets the number, without % signs. Default random means you use %random%. Only for Between. Starts as: random.
Minimum	The lowest number that can be picked, like 1. Starts as: 1.
Maximum (inclusive)	The highest number that can be picked, like 100. This number can be picked too. Starts as: 100.

Variables it adds

Variable	What it holds
%random%	The number that was picked (the variable name can be changed)
%randomFloat%	Only with Next Float: a number from 0 up to just below 1
%randomPercent%	Only with Next Float: the same as a whole percent, 0 to 100

Type id: core.randomNumber

Set global variable

Saves a value that every action can read later as ~name~, like a death counter. It can set it or count up and down. Kept after a restart by default.

Setting	What to put in
Variable name	The variable's name, like "deaths". Use it anywhere as ~deaths~.
Mode	Value = save exactly what you type. Increment = add to the current number. Decrement = subtract from it. Options: Value, Increment, Decrement. Starts as: Value.
Value	With Value: what to save. With Increment/Decrement: how much to add or subtract (empty = 1).
Keep after restart	Tick to keep it after Cuebot restarts. Untick for a temporary value that vanishes when Cuebot closes. Starts as: true.
Auto type	Tick so numbers and true/false are stored as real numbers/yes-no values and not plain text. Starts as: false.
Also save in variable	Optional. A variable to also receive the new value, without % signs, so you can use %name% in the next steps.

Type id: core.setGlobal

Set user variable

Saves a value that belongs to one viewer, like their score or favorite color. It can set it or count up and down. Kept after a restart by default.

Setting	What to put in
Variable name	The variable's name, like "score".
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User id	The viewer's id on their site. Empty = the viewer who started the action, or the one found by user name.
User name	The viewer's chat name, like "kris". Used to find the viewer when you give no id.
Mode	Value = save exactly what you type. Increment = add to the current number. Decrement = subtract from it. Options: Value, Increment, Decrement. Starts as: Value.
Value	With Value: what to save. With Increment/Decrement: how much to add or subtract (empty = 1).
Keep after restart	Tick to keep it after Cuebot restarts. Untick for a temporary value that vanishes when Cuebot closes. Starts as: true.
Auto type	Tick so numbers and true/false are stored as real numbers/yes-no values and not plain text. Starts as: true.
Also save in variable	Optional. A variable to also receive the new value, without % signs, so you can use %name% in the next steps.

Type id: core.setUserVariable

Set variable

Creates a variable for this run only, or changes it. Use it afterwards as %name%. Good for building a message or counting inside one action.

Setting	What to put in
Variable name	The variable's name without % signs, like "greeting". Use it later as %greeting%.
Value	What to store. You can mix %variables%, ~global variables~ and math like $math(%count% + 1)$.
Auto type	Tick so numbers and true/false are stored as real numbers/yes-no values and not plain text. Needed for greater/less than checks. Starts as: false.

Type id: core.setArgument