mtion studio script functions

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

mtion.getActiveClubhouse

Tells you which clubhouse is open in mtion studio right now.

Gives back: id, name and description of the open clubhouse, or null when none is open (or mtion studio is closed).

C#Python

var answer = await Cb.Call("mtion.getActiveClubhouse");

answer = cb.call("mtion.getActiveClubhouse")

mtion.getClubhouses

Lists every clubhouse of the mtion account that is signed in.

Gives back: A list of clubhouses. Each has id, name and description.

C#Python

var answer = await Cb.Call("mtion.getClubhouses");

answer = cb.call("mtion.getClubhouses")

mtion.getTriggers

Lists the external triggers in the clubhouse that is open in mtion studio.

Gives back: A list of triggers. Each has id, name and parameters (each with index, name and type).

C#Python

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

answer = cb.call("mtion.getTriggers")

mtion.isRunning

Checks whether mtion studio answered Cuebot the last time Cuebot asked it something.

Gives back: true when mtion studio answered last time, otherwise false.

C#Python

var answer = await Cb.Call("mtion.isRunning");

answer = cb.call("mtion.isRunning")

mtion.sendTrigger

Sets off an external trigger in your open mtion clubhouse, like confetti. It does not fail when mtion studio is closed; check the result instead.

Value	What to put in
trigger	The trigger's name in your clubhouse, like "Confetti", or its id.
parameters	Optional. Values for the trigger, by parameter name, like {"Amount": 5}. Lists of options take the option number.

Gives back: running (mtion studio answered), found (the trigger exists) and sent (it was set off), each true or false.

C#Python

var answer = await Cb.Call("mtion.sendTrigger", new { trigger = "Confetti", parameters = new { Amount = 5 } });

answer = cb.call("mtion.sendTrigger", trigger="Confetti", parameters={"Amount": 5})