Groups sub-actions

Add user to group

Puts a viewer into a group of viewers, like "VIPs". Good for rewarding someone who did something special. Groups are lists you can use in commands and points.

Setting	What to put in
Group	The group's name, like "VIPs".
Platform	The site the viewer is on, like twitch. The default %platform% means whoever started the action. Starts as: %platform%.
User name	The viewer's chat name. The default %user% means whoever started the action. Starts as: %user%.
User id	The viewer's id on their site. If known it is used first, otherwise the name is used. The default is whoever started the action. Starts as: %userId%.
Create the group if missing	Tick to create the group if it does not exist yet. Unticked, a missing group gives an error. Starts as: true.

Variables it adds

Variable	What it holds
%groupUserAdded%	True if they were added, false if they were already in the group

Type id: groups.addUser

Clear users from group

Takes every viewer out of a group but keeps the group itself. Good for starting over, like emptying a "Giveaway winners" list.

Setting	What to put in
Group	The group's name, like "Giveaway winners". A wrong name gives an error.

Variables it adds

Variable	What it holds
%groupUsersRemoved%	How many viewers were taken out

Type id: groups.clear

Remove user from group

Takes a viewer out of a group of viewers.

Setting	What to put in
Group	The group's name, like "VIPs".
Platform	The site the viewer is on, like twitch. The default %platform% means whoever started the action. Starts as: %platform%.
User name	The viewer's chat name. The default %user% means whoever started the action. Starts as: %user%.
User id	The viewer's id on their site. If known it is used first, otherwise the name is used. The default is whoever started the action. Starts as: %userId%.

Variables it adds

Variable	What it holds
%groupUserRemoved%	True if they were removed, false if they were not in the group

Type id: groups.removeUser

User in group

Checks if a viewer is in a group, then runs the True steps if yes or the False steps if no. Example: only VIPs may use a command.

Setting	What to put in
Group	The group's name, like "VIPs".
Platform	The site the viewer is on, like twitch. The default %platform% means whoever started the action. Starts as: %platform%.
User name	The viewer's chat name. The default %user% means whoever started the action. Starts as: %user%.
User id	The viewer's id on their site. If known it is used first, otherwise the name is used. The default is whoever started the action. Starts as: %userId%.
Save the answer in variable	The variable that receives the answer (true or false), without % signs. The default inGroup means you use %inGroup%. Starts as: inGroup.

Paths it can take: True, False.

Variables it adds

Variable	What it holds
%inGroup%	True if the viewer is in the group (the variable name can be changed in the settings)

Type id: groups.userInGroup