Reference Sub actions Overlays

Overlays sub-actions

Also on the Cuebot Docs site.

Pause, skip or mute overlay alerts

Controls the line of alerts on your stream overlay: pause or resume it, skip the alert playing now, or mute alert sounds and videos. This is the line of on-screen alerts, not the action queues on the Queues page.

Setting	What to put in
Mode	Pause = the alert playing finishes, new ones wait. Resume = go on. Skip = end the playing alert. Mute/Unmute = silence alert sounds and videos. Toggle = switch to the opposite. Options: Pause, Resume, Toggle pause, Skip current alert, Mute, Unmute, Toggle mute. Starts as: Pause.

Variables it adds

Variable	What it holds
%alertsPaused%	True if the alerts are paused now
%alertsMuted%	True if the alerts are muted now

Type id: overlays.alertQueue

Show alert

Shows an alert on your stream overlay yourself, as if someone followed or tipped. Good for testing an alert or making your own with a custom message.

Setting	What to put in
Design	Which alert design to use: custom, follower, subscriber, tip, cheer, raid, and so on. Pick the one that fits your alert. Options: custom, follower, subscriber, tip, cheer, raid, superchat, kicks, redemption, jewels, charityCampaignDonation, merch. Starts as: custom.
Name	The name shown in the alert. The default %user% is whoever started the action. Starts as: %user%.
Message	The message shown in the alert, if the design has room for one.
Amount	A number for the alert, like 5 for a 5 dollar tip. Designs can show different alerts for different amounts. Starts as: 1.
Currency	For money amounts, the currency code, like USD. Empty is fine otherwise.
Platform	The site the alert is from: twitch, kick, rumble or youtube. Designs can differ by site. Starts as: %platform%.

Type id: overlays.showAlert