Reference Script Functions Mtion

mtion studio 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.

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#

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

Python

answer = cb.mtion_get_active_clubhouse()

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#

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

Python

answer = cb.mtion_get_clubhouses()

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#

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

Python

answer = cb.mtion_get_triggers()

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#

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

Python

answer = cb.mtion_is_running()

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	In Python	What to put in
trigger	trigger	The trigger's name in your clubhouse, like "Confetti", or its id.
parameters	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#

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

Python

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