When you have text inputs in actions or filters, you might want parts of text to be automatically filled with dynamic values. This is exactly what the placeholder system allows.
Typical example
You have created a behavior that sends a message that says "Hello everyone!" and you want to add in this message the number of members present on your server to have a result like this:
"Hello everyone! Today we have 158 members on our server!"
Well this is possible with the placeholder system!
You just need to write this as a message in the configuration:
"Hello everyone! Today we have {guild_member_count} members on our server!"
Obviously, you should not write the quotation marks "
Format
All placeholders have the format {placeholder}.
List
Here is the list of all available placeholders.
Some placeholders can only work in certain contexts. For example, it is impossible to use the placeholder {event_channel} in the MEMBER_JOIN event because no channel is affected by the arrival of a new member.
Placeholders that do not depend on context
{character}
The name of the character concerned.
A common usage is to do an AI_SEND_MESSAGE action and pre-prompt something like: "You are {character} so answer like him."
Return example: Bobby
{guild_name}
The name of the server the bot is on.
For example, this can be useful if you make a welcome message and often change the name of your server.
Return example: My super server
{guild_member_count}
Gives the total number of members present on your server.
Return example: 158
{guild_boost_count}
Gives the total number of current boosts on your server.
Return example: 0
{guild_boost_tier}
Gives the boost-tier of your server.
Return example:
0
1
{guild_icon}
Gives the link to your server icon.
{guild_banner}
Gives the link to your server banner.
{guild_channel_count}
Gives the total number of current channels on your server.
Return example: 12
{guild_role_count}
Gives the total number of current roles on your server.
Return example: 5
{guild_owner}
Gives the name of the server owner.
Return example: <@239418288617160715>
Placeholders that depend on the context:
{event_message}
Gives the message context, usually when you use the MESSAGE event.
The return only keeps the formatting but not the mentions.
Return example: Hello everyone! Whizyyy
{event_message_raw}
Gives the message context, usually when you use the MESSAGE event.
The return fully retains the mentions and format of the initial message.
{event_message_stripped}
Gives the message context, usually when you use the MESSAGE event.
The return only keeps the text. For example, it removes mentions and the ** for bold.
Return example: Hello everyone! Whizyyy
{event_channel}
Give the mention of the channel concerned.
Return example: <@1144749550494564442>
{event_channel_name}
Give the name of the channel concerned.
Return example: general
{event_user}
Give the mention of the user concerned.
Return example: <@239418288617160715>
{event_user_effective_name}
Give the global name of the user concerned.
Return example: Darkkraft
{event_user_avatar}
Give the avatar of the user concerned.
{event_user_default_avatar}
Give the default avatar of the user concerned.
{event_member}
Give the mention of the member concerned.
Return example: <@239418288617160715>
{event_member_nickname}
Give the nickname of the member concerned.
Return example: The administrator
{event_member_effective_name}
Give the global name of the member concerned.
Return example: Darkkraft
{event_member_avatar}
Give the avatar of the member concerned.
{event_member_default_avatar}
Give the default avatar of the member concerned.
Parsing
If you want to test the return of placeholders, it's possible!
You can use the /placeholder parse command.
⚠️ Be careful, the {character} will not work because no character is associated.
