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 .

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

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 a larger object 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. Currently these objects are available:

{Guild}
{Channel}
{Member}
{User}
{Role}
{Invite}

Guild Variable

The guild variable gives you access to the properties of the guild (server) a command was used in or an event was triggered in. You can also access a specific guild by enclosing a guild ID in square brackets ({Guild[822426820447567872].name}).

For example:

{Guild.name}
{Guild[822426820447567872].name}
{Guild.roles}
{Guild.bans}
{Guild.icon}

Channel Variable

The channel variable gives you access to the properties of the channel a command was used in or an event was triggered in. You can also access a specific channel by enclosing a channel ID in square brackets ({Channel[1111802548312096778].name}).

For events this will be the channel associated with the event. For voice events this will be a voice channel.

For example:

{Channel.name}
{Channel[1111802548312096778].name}
{Channel.type}
{Channel.id}
{Channel.position}

Member Variable

The member variable gives you access to the properties of the guild member who used a command or triggered an event. You can also access a specific member by enclosing a member ID in square brackets ({Member[136327647792726016].avatar}).

For example:

{Member.user.username}
{Member[136327647792726016].user.username}
{Member.avatar}
{Member.roles}
{Member.presence}

User Variable

The user variable gives you access to the properties of the user who used a command or triggered an event. You can also access a specific user by enclosing a user ID in square brackets ({User[136327647792726016].avatar}).

For example:

{User.username}
{User.globalName}
{User.avatar}
{User.banner}

Role Variable

The role variable gives you access to the properties of a specific role, that can be either provided by a role ID or a role option. To access the object, enclosing a role ID in square brackets ({Role[905462520519745537].color}).

For example:

{Role[905462520519745537].icon}
{Role[option_role].name}
{Role[{event_role_id}].hoist}
{Role[{my_variable}].position}

Invite Variable

The invite variable gives you access to the properties of a specific invite to the server. You can access its information by enclosing a invite in square brackets ({Invite[botghost].expiresAt}).

For example:

{Invite[botghost].createdAt}
{Invite[9UPM6S4xyA].channel}
{Invite[{BGVAR_custom_variable}].maxUses}
{Invite[{my_variable}].uses}

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.

Variable

Information

{lowestValue({BGVAR_collection})}

Returns the lowest value in a collection.

{highestValue({BGVAR_collection})}

Returns the highest numerical value in a collection.

{lengthOfCollection({BGVAR_collection})}

Returns the length of a collection.

{valueAtPosition({BGVAR_collection}),[2]}

Returns the value at a specific position in the collection. Positions start at 0.

{positionOfValue({BGVAR_collection}),[hello]}

Returns the position of a value.

{collectionCharacterLength({BGVAR_collection})}

Returns the total character length of a collection.

{printAllValues({BGVAR_collection}),[Hello $value]}

Prints all values in a collection. The text returned can be set in the []. Use $value to print the value, and $index to display the index of the value shown.

{getRandomFromCollection({BGVAR_collection})}

Returns a random value from the collection.

Basic Variables

Error Variables

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

Variable

Description

{error_reason}

Returns the reason why the error occurred.

{error_message}

Returns the error message associated with the action the error occurred from.

{error_block}

Returns name of the block which the error occurred in.

Other Variables

You can view the available variables by checking the clipboard in the top right corner of each action. In the picture, the clipboard is indicated by the red arrow in a Plain Reply action.

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.

Variables

Details

Event variables

Data storage variables

Form variables

API response variables

Error handler variables

You can use a set of variables when your command or event triggers an error. You can use these variables to get, for example, the error reason. They can be used only below the "Error Handler" red block.

Option variables

Unique variables

Success / error handler variables

You can use a set of variables when your action triggers an error. (If enabled) You can use these variables to get, for example, the error reason, message or action block.

Loop variables

Created channel variables

Created / edited thread variables

Invite variables

Manipulate some text variables

Last updated 1 month ago

Was this helpful?