Commands
Commands allow you to assemble a set of Actions together as a cohesive set of steps that are initiated by a specific route. Commands come in a variety of forms, but share about 80% of the same functionality. All commands can be tested out by pressing the "Play" button next to them and can be edited by clicking the "Edit" button. Commands that are created by you can also be deleted by pressing the "Delete" button.
By default, commands of the same type are locked together. This means that if two commands were to run at the same time (EX: 2 Chat commands), the 1st command would start running and the 2nd comment will wait until the 1st is complete. This is designed to help prevent many commands of the same type from going off at the same time and cause some form of chaos. However, there are some circumstances in which you will want a command to always be able to run right away, regardless of if there are other commands of the same type already running. To do this, you need to toggle the Unlock Command switch when editing your command.
Below you'll find the various types of Commands that exist and what specific features each of them have:
Chat commands are triggered based on chat text entered by users. Commands by default are single word, case-insensitive, and all start with the "!" character. You must specify the name of the command, who is the minimum user type who can use it, the actual chat text commands that correspond to it, and the cooldown before the command can be used again.
You can specify 1 or more chat triggers per command, which is what will be looked for in order to run the command. Each trigger must have a space between it or if you want to have a multi-word trigger, then place a semi-colon ";" character between each set of words. (EX: "here is a trigger;here's another one")
You also have the option to allow for wild-card support for a chat command. This makes it so that if any of the triggers you specify are found ANYWHERE in the chat message, it will trigger the command. For example, using the trigger "what" with the wild card option would cause the command to be run for any of the following messages:
- "what is going on?"
- "who what where"
- "how in the what?"
MixPlay commands are linked to a specific MixPlay control and are triggered when that control is interacted with. For controls that allow it, you also may specify the cooldown of this command. All controls under a group cooldown at the same time when any of them are interacted with.
MixPlay buttons are clickable controls that are run when the button is clicked or the associated key is pressed. You must specify what type of interaction triggers this command to run and what the spark cost associated with it is. Buttons are the only type of control where a cooldown can be applied to them visually, causing the button to temporarily be disabled until the cooldown completes.
MixPlay joysticks allow a user to control a virtual joystick and have the direction they are pushing it be mapped to something on your computer. You can setup your joystick in one of a few different ways that will make the user's movement of the joystick move or use the keyboard/mouse on your computer. You can also specify the Dead Zone for the joystick, which means that it must be pushed in any direction more than the percentage specified for it to trigger. Additionally, if you are mapping the joystick to your mouse's movement, you can specify a multiplier to apply to the movement to make it move faster. Once you have setup the joystick, you can test it out by clicking the "Test Setup" button.
MixPlay text boxes are controls where a user can enter a set of text and run a command based off of it. This text is stored in the "$arg1text" Special Identifier, which can be used for any of the actions in the command.
Event commands occur when an associated event is triggered. Events command details are currently pre-populated based on the event that you selected. Future updates will allow you to create custom event commands.
Timer commands occur on a timely-basis as defined by the Timers feature. All that is required for a Timer command is to specify a name for it.