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
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.

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.
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.
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.
By selecting this option the value of the variable will be reset for all users who have a record in the variable.
Channel Target
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.

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.
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.
By selecting this option the value of the variable will be reset for all channels that have a record in the variable.
Server Target
You can optionally target a specific server with the Set Variable action. If you enter a server ID in this field, the variable will be set for that server.

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

Last updated
Was this helpful?
