Reference Script Functions Goals

Goals script functions

Also on the Cuebot Docs site.

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

goals.addPoints

Adds points to a goal, or takes them away with a negative number.

Value	What to put in
goal	Optional. The goal's name. Leave it out for the first goal.
points	How many points.
useMultiplier	Optional. true to use the goal's multiplier.

Gives back: The points really added.

C#

var answer = await Cb.Call("goals.addPoints", new { goal = "Emote ladder", points = 5 });

Python

answer = cb.call("goals.addPoints", goal="Emote ladder", points=5)

goals.get

Gives you a goal: its points, steps and settings.

Value	What to put in
goal	Optional. The goal's name. Leave it out for the first goal.

Gives back: An object with id, name, points, steps (each with name and points, lowest first), reachedThrough (the highest step already announced), multiplier, resetOnNewStream and values, or null when there is no such goal.

C#

var answer = await Cb.Call("goals.get", new { goal = "Emote ladder" });

Python

answer = cb.call("goals.get", goal="Emote ladder")

goals.list

Gives you every goal.

Gives back: A list of goals, each like goals.get gives.

C#

var answer = await Cb.Call("goals.list");

Python

answer = cb.call("goals.list")

goals.reset

Puts a goal back to 0 points, so every step can be reached again.

Value	What to put in
goal	Optional. The goal's name. Leave it out for the first goal.

Gives back: true.

C#

var answer = await Cb.Call("goals.reset");

Python

answer = cb.call("goals.reset")

goals.setMultiplier

Changes how much event points count. Points already added do not change.

Value	What to put in
goal	Optional. The goal's name. Leave it out for the first goal.
multiplier	2 = double, 1 = normal, 0.5 = half.

Gives back: true.

C#

var answer = await Cb.Call("goals.setMultiplier", new { multiplier = 0.5 });

Python

answer = cb.call("goals.setMultiplier", multiplier=0.5)

goals.setPoints

Sets a goal's points.

Value	What to put in
goal	Optional. The goal's name. Leave it out for the first goal.
points	The new number of points.

Gives back: true.

C#

var answer = await Cb.Call("goals.setPoints", new { points = 0 });

Python

answer = cb.call("goals.setPoints", points=0)