Reference Script Functions Hotkeys

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

hotkeys.list

Lists the hotkeys you made on the Hotkeys page.

Gives back: A list of hotkeys. Each has id, name, gesture (the keys, like "Ctrl+Shift+F1"), enabled (true/false), action (the action it runs) and group.

C#

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

Python

answer = cb.hotkeys_list()

hotkeys.press

Acts as if you pressed one of your Cuebot hotkeys. Its "Hotkey pressed" trigger and its action run. No real key is pressed.

Value	In Python	What to put in
hotkey	hotkey	The hotkey's name as shown on the Hotkeys page, like "Scene: BRB", or its id.

Gives back: true when the hotkey was found and pressed, false when no hotkey has that name or id.

C#

var answer = await Cb.Call("hotkeys.press", new { hotkey = "Scene: BRB" });

Python

answer = cb.hotkeys_press(hotkey="Scene: BRB")