Delete Variable

The Delete Variable action when triggered resets the value of any custom variable to the base value defined in its settings. It can be referenced in any action or condition throughout your bot's commands and events.

Custom Variable

In this section, you can manage which variable the bot will reset. You can select from a dropdown that will display the bot's variables. Variables on this list can be added, edited, and removed using the Data Storage module.

Targets

When using the Delete Variable action on a user or channel variable, a Targets section will be displayed. This will allow you to set the user or channel to reset the variable for.

User Target

Note: User Target only appears for user variables.

The Delete Variable action has three options that change to whom the variable of the action is stored. Below you can find detailed information about each option and how it can be used.

User who used the command

By selecting this option your variable will be stored to the user who used the most recent interaction; for example, the most recent button press, select menu choice, command run or the user who triggered the custom event.

User option

In commands, by selecting this option your variable will be stored to a user selected in a user option.

User Option

Here you can set the option variable for the User option (purple blocks) you are using. These can be easily added through the variable selector by clicking the Clipboard button.

User ID

By selecting this option your variable will be stored to a user specified via their user ID.

User ID

Here you can set the ID of the user to set a variable for. You can do this by pasting an ID directly from Discord (learn how here) or using a variable that returns a user ID. These can be easily added through the variable selector by clicking the Clipboard button.

All Users

By selecting this option the value of the variable will be reset for all users who have a record in the variable.

Channel Target

Note: Channel Target only appears for channel variables.

The Delete Variable action has two options that change to which channel the variable of the action is stored. Below you can find detailed information about each option and how it can be used.

Channel the command was used in

By selecting this option your variable will be stored to the channel the most recent interaction was used in; for example, the most recent button press, select menu choice, command run or the channel of the custom event.

Specific channel or variable

By selecting this option your variable will be stored to a channel specified via its ID.

Channel ID or Variable

Here you can set the ID of the channel to set a variable for. You can do this by pasting an ID directly from Discord (learn how here) or using a variable that returns a channel ID. These can be easily added through the variable selector by clicking the Clipboard button.

All channels

By selecting this option the value of the variable will be reset for all channels that have a record in the variable.

Objects

Note: This only works for object type custom variables.

Likewise to other variable actions, for objects the delete variable action will target a specific key or all keys to delete a value from.

Specific key

Targeting a specific key will delete a value from a specific key entered in the field below.

Key

This field only accepts the name of the key that was made in data storage. See the objects page for more info.

All Keys

This selection will delete all the values from all the keys of the object.