Reference Sub actions Spending

Spending sub-actions

Also on the Cuebot Docs site.

Add a purchase

Adds a purchase by hand, like a cash gift or a sale Cuebot cannot see. It counts toward the top spenders like any other purchase.

Setting	What to put in
User	Who spent the money. Starts as: %user%.
Platform	The platform to list them under. Leave it empty for Manual. Starts as: %platform%.
Amount	How much, like 10. Starts as: 0.
Currency	The currency, like EUR. Leave it empty for your chosen currency.
What it was	What it was, like Cash gift. Starts as: Manual.

Type id: spending.add

Get top spenders

Gets the top spenders of this stream, today, this week, this month, this year or all time, on one platform or all of them. Good for a !topspender command or an end-of-stream thank you.

Setting	What to put in
Period	Which time: This stream, Today, This week, This month, This year or All time. Days, weeks, months and years follow your computer's calendar. Options: This stream, Today, This week, This month, This year, All time. Starts as: This stream.
Platform	One platform, like Twitch. Leave it empty for every platform together.
How many	How many people to get, from 1 to 100. Starts as: 5.

Variables it adds

Variable	What it holds
%topSpender%	The name of the top spender (empty when nobody spent anything)
%topSpenderPlatform%	The top spender's platform
%topSpenderAmount%	What the top spender spent, in your chosen currency
%topSpenderFormatted%	The same with its currency sign, like $25.00
%topSpenders%	Everyone on the list with their amounts, like Alice ($25.00), Bob ($10.00)
%topSpendersCount%	How many people are on the list
%topSpendersTotal%	What everyone on the list spent together
%topSpendersFormattedTotal%	The same with its currency sign
%topSpendersJson%	The whole list as JSON, for code steps
%topSpender1%	The first place's name (topSpender2 is second place, and so on; also topSpender1Platform, topSpender1Amount and topSpender1Formatted)
%spendingCurrency%	Your chosen currency, like USD
%spendingPeriod%	The period the list is for, like This week

Type id: spending.getTop

Remove a person's purchases

Removes what one person spent, for example after a refund or a test. Good with a mod-only command.

Setting	What to put in
User	Whose purchases to remove. Starts as: %user%.
Platform	Only on this platform. Leave it empty for every platform. Starts as: %platform%.
Period	Only purchases in this time, like This stream. All time removes everything they ever spent. Options: This stream, Today, This week, This month, This year, All time. Starts as: All time.

Variables it adds

Variable	What it holds
%removed%	How many purchases were removed

Type id: spending.remove

Start a new stream for top spenders

Starts a new stream for the top spenders right now: "this stream" lists start empty and the exchange rates are fetched again. Cuebot does this by itself when you go live, so you only need it if your platform does not tell Cuebot.

Type id: spending.newStream