Reference Script Functions Polypop

PolyPop 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.

polypop.isConnected

Checks whether PolyPop is connected to Cuebot right now (at least one Cuebot plugin in PolyPop).

Gives back: true while at least one PolyPop plugin is connected, otherwise false.

C#

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

Python

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

polypop.triggerAlert

Sets off a WebSocket Alert in PolyPop and hands it some words to show. Fails with an error when PolyPop is not connected.

Value	What to put in
alertName	The alert's name as set in PolyPop, like "Follow". Needed.
variables	Optional. Words for the alert to use, like {"user": "CoolViewer"}. Every value is sent as text.

Gives back: How many PolyPop plugins got the alert.

C#

var answer = await Cb.Call("polypop.triggerAlert", new { alertName = "Follow", variables = new { user = "CoolViewer" } });

Python

answer = cb.call("polypop.triggerAlert", alertName="Follow", variables={"user": "CoolViewer"})