Reference Script Functions Crowdcontrol

Crowd Control 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.

crowdcontrol.getSession

Tells you about the Crowd Control game session that is running, and the timed effects that are active.

Gives back: active (true while a session runs), paused, gameSessionId, gameName, gamePackName and timedEffects (a list: requestId, effectName, user, status, timeRemaining in milliseconds).

C#

var answer = await Cb.Call("crowdcontrol.getSession");

Python

answer = cb.call("crowdcontrol.getSession")

crowdcontrol.isConnected

Checks whether Cuebot is connected to Crowd Control right now.

Gives back: true while connected, otherwise false.

C#

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

Python

answer = cb.call("crowdcontrol.isConnected")

crowdcontrol.sendTestEvent

Fakes a Crowd Control event inside Cuebot, so you can test your triggers. Nothing is sent to Crowd Control. Other kinds: effectFailure, effectRefund, timedEffectUpdated, timedEffectEnded, gameSessionEnd.

Value	What to put in
kind	Optional. Which event, like "effectSuccess" (default), "effectRequest", "timedEffectStarted", "coinExchange" or "gameSessionStart".

Gives back: true when the test event was sent, false when the kind is unknown.

C#

var answer = await Cb.Call("crowdcontrol.sendTestEvent", new { kind = "effectSuccess" });

Python

answer = cb.call("crowdcontrol.sendTestEvent", kind="effectSuccess")