See: General ( Name, Description, Public, Identifier, Reason, Cumulative, Help, Queue or Users ), Activation, Conditions ( Overview, Editing Conditions or Types of Conditions ) or Durations ( Add, Edit or Remove )
The timeout command is used to timeout users within chat.
For an overview of what the timeout command is and how to create them please watch the below.
General
See: Name, Description, Public, Identifier, Reason, Cumulative ( Enabled or Maximum Duration ), Help ( Use Default or Command ), Queue ( Use Default, Type or Name ) or Users ( Moderator, VIP, Viewer, Restore Moderator or VIP or Excluded )
The name of the command. This is shown within the user interface and chat when the command is triggered (if the notification is enabled).
When toggled on the command is public and can be downloaded by other users. If you wish to keep your commands private then toggle this off.
The identifier is used trigger the command from chat or identifier the command to trigger when multiple commands have the same cost.
The reason is added to the timeout message so you can tell the user was automated through InstructBot.
Cumulative
See: Enabled or Maximum Duration
When cumulative timeouts are enabled, if InstructBot has timed out a user and they have time left, the new timeout is appended to the length rather than replacing the current timeout.
The help section controls what Help command, if any, the command will appear within.
Note: The examples are for an Input command but this applies equally to all other command types which support help.
The use default toggle controls if the command will be included in the default help command, see here.
The queue section controls how the command is run. You can see an example of how queue's work here.
Note: The examples are for an Input command but this applies equally to all other command types.
The use default toggle controls if the command will be assign to the default queue for it's type, see here.
The type toggle button allows you to assign the command to the sequential or parallel queue when using the non-default queue for the command.
Users
See: Moderator, VIP, Viewer, Restore Moderator or VIP or Excluded
Restore moderator or VIP when timeout ends will restore a users state back to what they were before being timed out by InstructBot.
Allows you to set which users can't be timed out.
Note: You can also set which users can't be timed out on the users screen as well, see here.
The activation tab of a command controls when a command is enabled or disabled. The command can be activated in two different ways.
Note: The examples below are for a Text command and Input command but this applies equally to all other command types.
The first is having the Command is always active toggle button on. When on the command will always be considered active, even if not linked to the currently active application.
The second way is toggling on the Command is active when one or more of the selected profiles are active and then one of the selected profiles is linked to the currently active application, and the profile it's self is enabled.
In the above the Command is active when one or more of the selected profiles are active is toggled on and the Default is selected. This will cause the command to activate when the Default profile is linked to the active application.
Conditions
See: Overview, Editing Conditions ( Overview, Adding a Condition or Removing a Condition ) or Types of Conditions ( And, Or, Not, Application Active, Keyboard or Mouse Button )
Conditions are used by commands to indicate when they should execute. For example you might not want a command to run whilst you are pressing the Left Shift and W keys.
Creating a condition allows you to specify that the command should wait until you've released both of those keys and then execute.
The condition editor is common for all commands.
At the top of the editor is a root condition.
The root condition can act as an And Condition or Or Condition, depending upon what you require, and will always return true, e.g. the command should be executed, if there are no child conditions created.
Below the root condition are it's child conditions, if any. In the example below there is an Application Active condition.
Below that are then a number of buttons which can be used to add, remove, clear and move the conditions.
To create a new condition you must select the parent condition.
You can then click the add button.
If you've added a condition before, a new condition of that type will be added, otherwise you'll be shown a list of the available condition types, see Types of Conditions, were clicking on one will create a new condition.
If you then wish to change the type of condition added, you can click upon the dropdown portion of the add button.
Alternativity to using the add button above, you can use the add at the same level in the hierarchy to the parent condition you wish to add a new condition to.
This will only ever added to the linked condition, as such you do not need to select the parent condition first.
Note: Only container conditions can have child conditions added to them, and some are limited in the number which can be added. Please see Types of Conditions for more information.
To remove an existing condition you must select it.
You can then press the remove button to remove the condition.
Alternatively you can click the remove button linked to the condition.
If you wish to remove all conditions, you can instead press the clear button.
Note: You can't remove the root condition.
Types of Conditions
See: And, Or, Not, Application Active, Keyboard or Mouse Button
Container Condition
If a condition is marked as a container condition it can have child conditions which will be evaluated when it's evaluated. Some container conditions have a maximum number of children, if so they will be marked as much.
Container Condition: Unlimited.
The And Condition is satisfied when all of it's children are satisfied; otherwise it is unsatisfied.
In the example above the And condition would be satisfied when both the left shift and W keys a pressed. It would be unsatisfied if either the Left Shift key or the W key were pressed or nether the keys were pressed.
Note: If an And condition has no children, it is satisfied.
Container Condition: Unlimited.
The Or Condition is satisfied when any of it's children are satisfied; otherwise it is unsatisfied.
In the example above the Or condition would be satisfied when the left shift key was pressed, the W key was pressed or both the left shift key and w are pressed. It would be unsatisfied when nether the keys are pressed.
Note: If an Or condition has no children, it is satisfied.
Container Condition: One.
The Not Condition inverts the result of it's child condition.
In the example above the Not condition would be satisfied when the application is not active, and satisfied when the application is active.
Note: If an Not condition has no children, it is satisfied.
The Application Active condition returns satisfied depending upon it's match type. When configured to look for an active application is will return satisfied when that application is active and unsatisfied when that application in inactive.
When configured to look for an inactive application is will return satisfied when that application is inactive and unsatisfied when that application in active.
The Keyboard condition returns satisfied depending upon it's match type and specified key. When configured to look for a pressed key it will return satisfied when that key is down and unsatisfied when that key is up.
When configured to look for a released key it will return satisfied when that key is up and unsatisfied when that key is down.
You can control the key queried by clicking in the editor and pressing the required key.
The Mouse Button condition returns satisfied depending upon it's match type and specified button. When configured to look for a pressed button it will return satisfied when that button is down and unsatisfied when that button is up.
When configured to look for a released button it will return satisfied when that button is up and unsatisfied when that button is down.
You can control the button queried by clicking in the editor and pressing the required button.
The duration's control how long a user is timed out for, for a linked trigger.
Each duration has a time, and can have a bits cost, donation cost and points cost. For example in the below the 1 minute duration has a trigger of 100 bits or a donation trigger of £1.
To edit a duration double click upon the row to open the editor.
Duration: Is the length of time in seconds the user will be timed out for.
Bits: The bits required to trigger the timeout.
Donation: The donation required to trigger the timeout.
Points: The points required to trigger the timeout.
