Custom Variable Condition

This condition compares a custom variable to a value and run actions based off the comparison.

Configuration of at least one Custom Variable is necessary to enable the functionality of this Condition. You can create a custom variable in data storage.

Run multiple actions

This option allows you to set the condition to run multiple actions at the same time. This means if multiple conditions are met, then each true condition will be run simultaneously. When disabled, only the first met condition will be executed.

Custom Variable

Select a custom variable from this dropdown menu to add to the condition.

Value

This field is where you input a value for the custom variable you chose above to be compared against. You can use variables and options in this field.

Targets

Both the user and channel targets can force the condition to target a specific user or channel for the basis of the condition.

User Target

User who used the command

The condition will target the custom variable of the user who used the command / event or whoever clicked a button / menu option.

User Option

This selection will make the condition target a user selected from a user option for the custom variable.

User Option

This field only accepts user option variables inside it. Therefore you must have a user option in your command for this field to work.

User ID

This type will make the condition target a user ID for the custom variable.

User ID

This field accepts plain user IDs or variables that return a plain user ID. Keep in mind it has to be a plain ID with no extra spaces or symbols.

Channel Target

Channel the command was used in

This target will allow the condition to target the channel that the command / event was triggered in or where a button / menu option was clicked for the custom variable.

Specific channel or variable

This type if selected will allow the condition to target a specific channel or a variable for the custom variable.

Channel ID or variable

This field accepts a plain channel ID or variable. You can still use a channel option in this field however since the field only accepts plain ID's, you would need to use the option variable inside a basic one that returns a channel ID. For example: {channel_id[option_channel]} See the channel option page for more info.

Condition Type

The condition type field is where you select what type of comparisons you would like for your custom variable and the value. Here is the list below.

Click the Add Condition block to add the comparison to your condition in the builder.​

By clicking on the newly added comparison that is now attached to the condition. You can edit it if needed by selecting it. You will be able to edit the Condition Type and the Value

Here is an example layout for this condition: