Points sub-actions

Add points

Gives points to a viewer, like a reward for a trivia win. Points are your channel currency that viewers collect.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Amount	How many points to give, a whole number like 100. Starts as: 10.
Currency	The name of the points, like "Coins". Empty = your normal points.
Apply user/group multipliers	Tick to give more (or less) points if the viewer or their group has a points multiplier. Starts as: false.
Also save the balance in variable	Optional. A variable to also receive their new total, without % signs, like userPoints. Empty = only %points%.

Variables it adds

Variable	What it holds
%points%	The viewer's total after the change
%pointsAdded%	How many points were really given
%pointsUser%	The viewer's name
%pointsName%	The name of the points

Type id: points.add

Award points to all

Gives points to every viewer Cuebot knows, or only to those who are around. Good for a "free points for everyone" moment.

Setting	What to put in
Platform	Only give to viewers on this site. Empty = every site.
Amount	How many points each viewer gets, a whole number like 10. Starts as: 10.
Only active (present) users	Tick to give only to viewers who chatted recently, not to everyone Cuebot has ever seen. Starts as: false.
Apply user/group multipliers	Tick to give more (or less) points to viewers or groups with a points multiplier. Starts as: false.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsAwarded%	How many viewers got points

Type id: points.awardAll

Award points to group

Gives points to every viewer in a group, like "VIPs". Groups are made on the Users & Groups page.

Setting	What to put in
Group	The group's name, like "VIPs".
Amount	How many points each member gets, a whole number like 10. Starts as: 10.
Apply multipliers	Tick to give more (or less) points to viewers or groups with a points multiplier. Starts as: false.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsAwarded%	How many viewers got points

Type id: points.awardGroup

Award points to present viewers

Gives points to every viewer who chatted recently. Good for a "thanks for being here" bonus.

Setting	What to put in
Platform	Only give to viewers on this site. Empty = every site.
Amount	How many points each viewer gets, a whole number like 10. Starts as: 10.
Apply multipliers	Tick to give more (or less) points to viewers or groups with a points multiplier. Starts as: true.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsAwarded%	How many viewers got points

Type id: points.awardPresent

Check points

Checks if a viewer has enough points, then runs the Enough steps if yes or the Not enough steps if no. It takes no points. Good before a paid action.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Amount	How many points are needed, a whole number like 100. Starts as: 0.
Stop the action when not enough	Tick to stop the whole action when they do not have enough. Untick to run the Not enough steps instead. Starts as: true.
Also save the balance in variable	A variable to also receive their total, without % signs. The default userPoints means you can use %userPoints%. Starts as: userPoints.
Currency	The name of the points, like "Coins". Empty = your normal points.

Paths it can take: Enough, Not enough.

Variables it adds

Variable	What it holds
%points%	The viewer's total points
%pointsEnough%	True if they have enough
%pointsMissing%	How many more points they need (0 if enough)

Type id: points.check

Delete user points

Removes a viewer from the points list completely, as if they never had any. Use "Reset user points" if you only want zero.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsDeleted%	True if they had points that were deleted

Type id: points.delete

Get points

Looks up how many points a viewer has and puts it in a variable. Good for a !points command that tells chat their total.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. The default %input0% is the first word after the command. Empty = whoever started the action. Starts as: %input0%.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%points%	The viewer's total points
%pointsFormatted%	The total with the points name, like 500 Coins
%pointsRank%	Their place in the points ranking (1 = first)
%pointsUser%	The viewer's name
%pointsName%	The name of the points

Type id: points.get

Get points definition

Reads how a points currency is set up (its name, symbol and so on) and saves it in variables. Mostly for advanced uses.

Setting	What to put in
Currency	The name of the points, like "Coins". Empty = your normal points.
Save in variable	The start of the variable names, without % signs. The default pointsDefinition gives %pointsDefinition.name% and more. Starts as: pointsDefinition.

Variables it adds

Variable	What it holds
%pointsDefinition.name%	The name of the points (the start can be changed in the settings)
%pointsDefinition.singularName%	The name for one point, like Coin
%pointsDefinition.symbol%	The symbol, if any

Type id: points.getDefinition

Get points leaderboard

Builds the top list of viewers with the most points, as text for chat and as variables. Good for a !top command.

Setting	What to put in
How many	How many viewers to list, like 5. Starts as: 5.
Skip the first (offset)	How many places to skip. 0 starts at first place, 5 starts at sixth. Starts as: 0.
Platform	Only list viewers on this site. Empty = every site.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%leaderboard%	The list as one line, like "1. Kris (500 Coins), 2. Sam (400 Coins)"
%leaderboardCount%	How many viewers are in the list
%leaderboard1User%	The name of first place (leaderboard2User is second, and so on)
%leaderboard1Points%	The points of first place (leaderboard2Points is second, and so on)

Type id: points.leaderboard

Get points multiplier

Looks up how fast a viewer earns points. 1 is normal, 2 is double. Their group can change it too.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsMultiplier%	How fast they earn points in all (1 = normal)
%pointsUserMultiplier%	The multiplier set just for them (1 if none)

Type id: points.getMultiplier

Remove points

Takes points away from a viewer. Their total never goes below 0. Use "all" to empty their balance.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Amount	How many points to take, a whole number like 50, or the word all. Their total never goes below 0. Starts as: 10.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%points%	The viewer's total after the change
%pointsRemoved%	How many points were really taken

Type id: points.remove

Reset everyone's points

Sets everyone's points back to zero. Be careful: this cannot be undone. Good for a fresh start each season.

Setting	What to put in
Platform	Only reset viewers on this site. Empty = every site.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsReset%	How many viewers were reset

Type id: points.resetAll

Reset user points

Sets one viewer's points back to zero. The viewer stays in the list. Use "Delete user points" to remove them completely.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Also save the balance in variable	A variable to also receive their new total, without % signs. The default userPoints means you can use %userPoints%. Starts as: userPoints.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%points%	The viewer's total after the reset (0)

Type id: points.resetUser

Set group points multiplier

Makes everyone in a group earn points faster or slower, like 2 for double. Good for rewarding "Subscribers" or "VIPs".

Setting	What to put in
Group	The group's name, like "VIPs".
Multiplier	How much faster, like 2 for double or 1.5 for one and a half times. Empty removes the group's multiplier. Starts as: 2.
Currency	The name of the points, like "Coins". Empty = your normal points.

Type id: points.setGroupMultiplier

Set points

Sets a viewer's points to exactly a number, no matter how many they had before. Use "Add points" to give extra instead.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Amount	The new total, a whole number like 500. Starts as: 0.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%points%	The viewer's total after the change

Type id: points.set

Set user points multiplier

Makes one viewer earn points faster or slower, like 2 for double. Good as a special thank-you for a supporter.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Multiplier	How much faster, like 2 for double or 1.5 for one and a half times. Empty removes their multiplier. Starts as: 2.
Currency	The name of the points, like "Coins". Empty = your normal points.

Variables it adds

Variable	What it holds
%pointsMultiplier%	How fast they earn points in all now

Type id: points.setUserMultiplier

Spend points

Charges a viewer points, if they have enough. It runs the Paid steps if it worked or the Not enough steps if they were too poor. Good for paid commands.

Setting	What to put in
Platform	The site the viewer is on, like twitch. Empty = the site of whoever started the action.
User name	The viewer's chat name. Empty = whoever started the action. Viewers must have chatted before.
User id	Optional. The viewer's id on their site. If given, it is used instead of the name.
Amount	How many points it costs, a whole number like 100, or the word all. Starts as: 100.
Stop the action when not enough	Tick to stop the whole action when they cannot pay. Untick to run the Not enough steps instead. Starts as: false.
Currency	The name of the points, like "Coins". Empty = your normal points.

Paths it can take: Paid, Not enough.

Variables it adds

Variable	What it holds
%points%	The viewer's total after the payment
%pointsSpent%	True if the payment worked
%pointsCost%	How many points it cost
%pointsMissing%	How many more points they would have needed (0 if paid)

Type id: points.spend

Transfer points

Moves points from one viewer to another, like a !give command. It runs the Transferred steps if it worked or the Failed steps if not.

Setting	What to put in
Platform	The site the giver is on, like twitch. Empty = the site of whoever started the action.
User name	The giver's chat name. Empty = whoever started the action.
User id	Optional. The giver's id on their site. If given, it is used instead of the name.
To user name	Who gets the points. The default %input0% is the first word after the command, like !give kris 50. Starts as: %input0%.
To user id	Optional. The receiver's id on their site. If given, it is used instead of the name.
To platform	The site the receiver is on. Empty = the same site as the giver.
Amount	How many points to give. The default %input1% is the second word after the command. A whole number, or the word all. Starts as: %input1%.
Currency	The name of the points, like "Coins". Empty = your normal points.

Paths it can take: Transferred, Failed.

Variables it adds

Variable	What it holds
%points%	The giver's total after the transfer
%pointsTransferred%	How many points were moved
%targetPoints%	The receiver's total after the transfer
%pointsError%	If it failed: the reason, like "not enough points"

Type id: points.transfer