Reference Script Functions Emotes

Emotes script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (a cb method each, or cb.call). See Script functions for how to use them.

emotes.find

Finds the emotes in a chat message, from the platform itself and from 7TV, BTTV and FFZ. Handy for emote rain or counting emotes.

Value	In Python	What to put in
platform	platform	Optional. Where the message is from: "Twitch", "YouTube", "Kick" or "Rumble". Leave it out for the platform of the trigger (or Twitch).
message	message	Optional. The message text, like "hello KEKW". Leave it out for the message of the trigger.

Gives back: A list. Each emote has start and length (where it sits in the text), code (like "KEKW"), provider, imageUrl and zeroWidth.

C#

var answer = await Cb.Call("emotes.find", new { platform = "Twitch", message = "hello KEKW catJAM" });

Python

answer = cb.emotes_find(platform="Twitch", message="hello KEKW catJAM")

emotes.list

Lists every emote code Cuebot knows for a platform: 7TV, BTTV and FFZ emotes, plus platform emotes it has seen in chat.

Value	In Python	What to put in
platform	platform	Optional. "Twitch", "YouTube", "Kick" or "Rumble". Leave it out for Twitch.

Gives back: A list of emote codes as text, like ["KEKW", "catJAM"], sorted A to Z.

C#

var answer = await Cb.Call("emotes.list", new { platform = "Twitch" });

Python

answer = cb.emotes_list(platform="Twitch")

emotes.refresh

Downloads the 7TV, BTTV and FFZ emote sets again, so new emotes show up. Only providers that are turned on are loaded.

Value	In Python	What to put in
force	force	Optional. true (the default) always downloads fresh sets; false uses copies Cuebot saved recently.

Gives back: How many emotes Cuebot knows now.

C#

var answer = await Cb.Call("emotes.refresh");

Python

answer = cb.emotes_refresh()