Introduction
When you right click-Edit commands or double click on your button in your deck, you can press + to start adding commands to execute when the button is pressed.
- Once a button is triggered, all enabled commands are executed
-
You can disable a command (and prevent it from executing) by checking Off on the very right side of the command. Disabled commands have a red color.
Disabled command
-
You can copy a command (or multiple commands) by pressing the scissors icon and pasting it anywhere else (even in another button in another deck)
-
You can freely rearrange your commands by pressing the ball icon (very left side) and dragging them to a different position. Select multiple commands to drag all of them at the same time. You can also use up and down arrows for the same effect.
- If you accidentally delete or rearrange a command, you can press Undo to revert the action and Redo to redo the action.
- When typing in an input box, you can press CTRL+Z to undo what you typed last
- You can temporarily block a button from executing
-
You can use comments to organize your buttons. Simply create a new Comment command, give it some relevant description and place all relevant commands inside of it!
Command delays are absolute and not related to each other. You can think of them as a timeline, they do not affect each other in any way.
Example 1: If you set up the first command to trigger at 1000ms and the second command to trigger at 1000ms, both commands will trigger at 1000ms, one right after another (in this case order matters), exactly 1000ms from when the button was pressed.
Example 2: If you set up your first command to trigger at 5000ms and your second command to trigger at 2000ms, the second command will be triggered exactly 2000ms from when you pressed the button and then first command will be triggered exactly 3000ms after it (5000ms from when you pressed the button).\
The command delay is superior to the command order, which means that a second command with a shorter delay will be always triggered before the first command with a longer delay.\
You cannot use variables in command delays, but you can use Wait for Timeout command instead.
When you start using commands in LioranBoard, you will notice that some parameter boxes have yellow color and some have white color.
It’s extremely important to know the difference as you need to format your input according to the color of the box.
| Operation | White Box | Yellow Box |
|---|---|---|
| Inserting another variable | You must wrap other variables in /$$/. /$myVariable$/ |
You can directly type another variable.myVariable |
| Inserting array value | You must wrap them in /$$/. /$myArray[0]$/ |
You can directly insert them. myArray[0] |
| Inserting real values (numbers) | You can directly insert them.26 |
You can directly insert them. 26 |
| Inserting string values (text) | You can directly insert them, such as Hello World and even use new lines by pressing ENTER |
You have to wrap any string in double/single quotes. "Hello World" or 'Hello World' |
| Using a combination of strings and variables | You can insert a variable into text by wrapping it in /$$/. Hello world, this is my /$myVariable$/, isn't it cool? |
You must wrap any string in double/single quotes and use + to combine them with other variables. The whole value must be enclosed in parentheses. ( "Hello World, this is my " + myVariable + ", isn't this cool?" ) |
| Math Operations | All math operations must be enclosed in /$$/ and parentheses.Hello world, do you know what's 3+7? It's /$(3+7)$/! |
All math operations must be enclosed in parentheses.( "Hello world, do you know what's 2+7? It's " + (2 + 7) + "!" ) |
The following premade/permanent global variables are accessible from all the buttons and their commands at all times. These global variables can be viewed in the Variable Viewer in your receiver. You can retrieve/access them by using the Get Global Variable command, or reference them with global.variablename in a command.
| Variable | Explanation |
|---|---|
| transmitter_connected | True if connected, false if not connected |
| twitch_chat_connected | True if connected, false if not connected |
| twitch_client_id | LioranBoard Twitch Client ID, used in Twitch API calls |
| main_directory | Main directory where LioranBoard folder resides. Useful for extension makers to be able to easily copy files. |
| Architecture | Type of architecture you’re on. x64 or x86. |
| elapsed_time | Elapsed time in seconds since you last started LioranBoard |
| since_2020 | Elapsed time in seconds since January 1st, 2020. |
| mouse_x | Current x position of your mouse |
| mouse_y | Current y position of your mouse |
| twitch_accounts | Array of all linked Twitch account login names |
| Main | An object containing information about your main OBS connection. |
| Main.connected | Whether LioranBoard is currently connected to your main OBS, true = connected, false = disconnected |
| Main.current_scene | Current scene in your main OBS |
| Main.previous_scene | Previous scene in your main OBS |
| administrator_mode | True if running in Administrator mode |
| trigger_type | Array that lists all available trigger types |