Reference Script Functions Tits

T.I.T.S. 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.

tits.activateTrigger

Runs one of the triggers you set up in T.I.T.S., by its id or name. Fails with an error when T.I.T.S. is not connected.

Value	In Python	What to put in
trigger	trigger	The trigger's id or name, like "Rain".

Gives back: true when T.I.T.S. accepted it.

C#

var answer = await Cb.Call("tits.activateTrigger", new { trigger = "Rain" });

Python

answer = cb.tits_activate_trigger(trigger="Rain")

tits.activateTriggerByName

Runs one of the triggers you set up in T.I.T.S., by its name. Fails with an error when T.I.T.S. is not connected.

Value	In Python	What to put in
triggerName	trigger_name	The trigger's name as T.I.T.S. shows it, like "Rain".

Gives back: true when T.I.T.S. accepted it.

C#

var answer = await Cb.Call("tits.activateTriggerByName", new { triggerName = "Rain" });

Python

answer = cb.tits_activate_trigger_by_name(trigger_name="Rain")

tits.connect

Starts connecting to T.I.T.S. It does not wait: Cuebot keeps trying in the background until it works.

Gives back: true once connecting has started (not when it is connected).

C#

var answer = await Cb.Call("tits.connect");

Python

answer = cb.tits_connect()

tits.disconnect

Disconnects Cuebot from T.I.T.S.

Gives back: true when done.

C#

var answer = await Cb.Call("tits.disconnect");

Python

answer = cb.tits_disconnect()

tits.getItems

Lists the items you can throw in T.I.T.S.

Gives back: A list of items. Each has id and name.

C#

var answer = await Cb.Call("tits.getItems");

Python

answer = cb.tits_get_items()

tits.getTriggers

Lists the triggers you set up in T.I.T.S.

Gives back: A list of triggers. Each has id and name.

C#

var answer = await Cb.Call("tits.getTriggers");

Python

answer = cb.tits_get_triggers()

tits.isConnected

Checks whether Cuebot is connected to T.I.T.S. (Twitch Integrated Throwing System) right now.

Gives back: true while connected, otherwise false.

C#

var answer = await Cb.Call("tits.isConnected");

Python

answer = cb.tits_is_connected()

tits.throwItemByName

Throws an item at your model in T.I.T.S. Fails with an error when T.I.T.S. has no item with that name or is not connected.

Value	In Python	What to put in
itemName	item_name	The item's name as T.I.T.S. shows it, like "Tomato". An id works too.
delay	delay	Optional. Seconds between throws when throwing more than one. Default 0.05.
amount	amount	Optional. How many to throw, 1 or more. Default 1.

Gives back: true when something was thrown.

C#

var answer = await Cb.Call("tits.throwItemByName", new { itemName = "Tomato", amount = 5 });

Python

answer = cb.tits_throw_item_by_name(item_name="Tomato", amount=5)

tits.throwItems

Throws items at your model in T.I.T.S., picked at random from your list. Fails with an error when one of the items is unknown.

Value	In Python	What to put in
items	items	The items to pick from, by name or id: a list like ["Tomato", "Pillow"], or text split with commas.
delay	delay	Optional. Seconds between throws. Default 0.05.
amount	amount	Optional. How many to throw, 1 or more. Default 1.

Gives back: How many items were thrown.

C#

var answer = await Cb.Call("tits.throwItems", new { items = new[] { "Tomato", "Pillow" }, amount = 10 });

Python

answer = cb.tits_throw_items(items=["Tomato", "Pillow"], amount=10)