Variables

Variables allow you to store data from API requests, action outputs, custom data and more. Variables can be used in almost every field of the actions and conditions custom command and event builder.

The available variables in your command-builder or event-builder may vary depending on the action, custom variables you have, API requests you use, and the event you might be using in case you are using the event builder. Here you may find some general information on what they are and how to use them.

Targeting#

You can add a target to your variable to get data of a specific user, channel, role or server (more targeting options are available when using Object Variables). To do so, add square brackets [] at the very end of your variable*. Make sure to add a valid ID, variable or option. See below for more info.

* Targeting is slightly different for object variables: the square brackets go before the first dot. For example, {Channel[ID].name} instead of {Channel.name[ID]}.

Plain ID#

You can use a plain ID as a target. This means the variable will always return the value of the same user, channel or role.

Below are some examples:

• {user_icon[136327647792726016]}
• {user_joinedAt[136327647792726016]}
• {channel_name[1021852614725480448]}

Options#

In custom commands you can use an option for your target (make sure it's a valid variable type: you need to use user options if you want to target a user using a option). The variable name should be inside your square brackets [], without any curly brackets {} around it, and preceded by option_.

Below are some examples:

• {user_icon[option_user]}
• {user_joinedAt[option_player]}
• {channel_name[option_channel]}

Variables Containing an ID#

Lastly, you can also use other variables that contain an ID. Unlike options, make sure to paste the full variable inside your square brackets [], including the curly brackets {}.

Below are some examples:

• {user_icon[{bot_id}]}
• {user_joinedAt[{api.response.id}]}
• {channel_name[{BGVAR_my_custom_variable}]}

Storing Custom Data#

Storing Data across all commands and events#

If you want to store data across all commands and events, you can use the data storage, which allows you to store and retrieve data with different types of variables.

Storing Data in a command or event#

You can also store data only in a specific command / event execution, meaning that once the execution of the command / event is completed, saved data will be deleted. This is useful to easily store temporary data. Check out the Set a unique variable page to learn more.

Variables#

Object Variables#

Some variables in BotGhost allow you to access properties of Discord objects, such as guilds, channels, or members, through dot notation. These variables start with a Capital letter and give you access to all the properties available on their respective Discord.js objects. For example, {User[136327647792726016].username} would return the username of the user with that ID. Dot notation allows you to access sub-objects of an object. For example, {Message.channel.name} will return the name of the channel the message was sent in. All properties and connections to other objects are described in the discord.js Documentation.

You can view a list of all properties of an object through the variable selector (clipboard icon). Objects highlighted in green do not require you to provide an ID or a parameter for the object variable to work (for example, when you run a command the Guild object is automatically set to return information about the server the command was used in. You can however overwrite the pre-defined value with [VALUE], as described above). Some object variables do not require a selector depending on the command or event type. For example, in a command, {User.username} would return the username of the user who ran the command. These are shown in green with the text "Available". All other objects require an ID to be specified.

Currently these objects are available:

Music Variables#

There are also some variables that allow for integration with the music actions. With these, you can do things like fetch information about the song or the player.

Music Objects#

The following are object variables for music actions that are accessed the same way as described in the Object Variables section.

Music Variables#

The following variables can be used as-is, similar to basic variables.

Collection / Array Variables#

BotGhost offers some variables you can use for any array or collection (even from an API response), which allow you to retrieve specific information of the collection.

Basic Variables#

Below are all basic variables that you can use in the command or event builder.

Error Variables#

Those variables can be used with the error handler block or success / error handles when something goes wrong with your tree.

Other Variables#

You can view all the available variables by checking the clipboard in the top right corner of a text input. This will open up a menu with a wide list of variables you can use in your command or event.

The available variables in your command-builder or event-builder may vary depending on the action, custom variables you have, API requests you use, and the event you might be using in case you are using the event builder.