Commands sub-actions

Get command group state

Checks a group of chat commands and tells you if all, none or some are turned on. Command groups are made on the Commands page.

Setting	What to put in
Command group	The command group's name from the Commands page.

Variables it adds

Variable	What it holds
%commandGroupState%	0 = all are off, 1 = all are on, 2 = some on and some off
%commandGroupEnabled%	True if the group has commands and all are on
%commandGroupCount%	How many commands are in the group

Type id: commands.getGroupState

Get command state

Checks if one chat command is turned on, and how many times it has been used. Pair it with an If step to react.

Setting	What to put in
Command	The command's name from the Commands page. The default %commandName% is the command that started this action. Starts as: %commandName%.

Variables it adds

Variable	What it holds
%commandEnabled%	True if the command is on
%commandStateName%	The command's name
%commandCounter%	How many times the command has been used

Type id: commands.getState

Get commands

Makes a ready list of your chat commands as text, like "!hello, !discord, !uptime". Good for a !commands reply.

Setting	What to put in
Save in variable	The start of the variable names, without % signs. The default commands gives %commands% (the text), %commandsList% and %commandsCount%. Starts as: commands.
Only this group	Only list commands of this command group. Empty or All = every group.
List	First alias = each command's first name. All aliases = every name a command answers to. Names = the name you gave it. Options: First alias, All aliases, Names. Starts as: First alias.
Separator	What goes between the commands, like a comma and a space. Starts as: ,.
Include disabled commands	Tick to also list commands that are turned off. Starts as: false.
Include all (ignore each command's Include option)	Tick to also list commands that are set to be left out of the list. Starts as: false.
Only commands the user may use	Tick to list only the commands the viewer who started the action is allowed to use. Starts as: false.

Variables it adds

Variable	What it holds
%commands%	The commands as one line of text (the variable name can be changed in the settings)
%commandsCount%	How many commands were listed

Type id: commands.getCommands

Reset command counters

Sets a command's use counter back to zero, and/or the counters of single viewers. Useful for a "counter" command you want to restart.

Setting	What to put in
Command	The command's name from the Commands page. The default %commandName% is the command that started this action. Starts as: %commandName%.
Reset	Counter = the total count. User counters = the counts of single viewers. Both = both. Options: Counter, User counters, Both. Starts as: Counter.
User's platform	The site of the viewer, when you reset just one viewer. The default %platform% is whoever started the action. Starts as: %platform%.
Only this user id	The id of the one viewer to reset. Empty = reset every viewer's counter.

Type id: commands.resetCounters

Set command group state

Turns all chat commands of a command group on or off, or flips them. Good for switching a whole set at once, like game commands.

Setting	What to put in
Command group	The command group's name from the Commands page.
State	Enable turns them on. Disable turns them off. Toggle turns all on unless they already are, then turns them off. Options: Enable, Disable, Toggle. Starts as: Enable.

Variables it adds

Variable	What it holds
%commandGroupCount%	How many commands were changed

Type id: commands.setGroupState

Set command state

Turns one chat command on or off, or flips it. Good for a command that should only work during part of the stream.

Setting	What to put in
Command	The command's name from the Commands page. The default %commandName% is the command that started this action. Starts as: %commandName%.
State	Enable turns it on. Disable turns it off. Toggle switches it to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Variables it adds

Variable	What it holds
%commandEnabled%	True if the command is on now

Type id: commands.setState