Default Variables

The following blocks will be present and accessable as defaults when running any tag.

Meta Variables

Meta variables reference meta attributes about the tag invocation.

Args Block

class TagScriptEngine.StringAdapter(string: str, *, escape: bool = False)[source]

The {args} block represents the arguments passed after the tag name when invoking a tag. If no parameter is passed, it returns all the text after the invocation name. If an index is passed, it will split the arguments into a list by the given splitter, and return the word at that index. The default splitter is a “ “.

Usage: {args([index]):[splitter]>}

Payload: splitter

Parameter: index

Examples:

In the following examples, assume the tag’s name is argstag and the message content is [p]argstag My dog is cute! Would you like to see a photo?.

{args}
# My dog is cute! Would you like to see a photo?

{args(1)}
# My

{args(2):!}
# Would you like to see a photo?

Uses Block

class TagScriptEngine.IntAdapter(integer: int)[source]

The {uses} block returns the number of times a tag has been used.

Usage: {uses}

Payload: None

Parameter: None

Examples:

{uses}
# 1

Discord Object Variables

These blocks reference Discord objects from the tag invocation context.

Author Block

The {author} block with no parameters returns the tag invoker’s full username and discriminator, but passing the attributes listed below to the block payload will return that attribute instead.

Aliases: user

Usage: {author([attribute])

Payload: None

Parameter: attribute, None

id: The author’s Discord ID.

name: The author’s username.

nick: The author’s nickname, if they have one, else their username.

avatar: A link to the author’s avatar, which can be used in embeds.

discriminator: The author’s discriminator.

created_at: The author’s account creation date.

timestamp: The author’s account creation date as a UTC timestamp.

joined_at: The date the author joined the server.

joinstamp: The author’s join date as a UTC timestamp.

mention: A formatted text that pings the author.

bot: Whether or not the author is a bot.

color: The author’s top role’s color as a hex code.

top_role: The author’s top role.

roleids: A list of the author’s role IDs, split by spaces.

boost: If the user has boosted, this will be the UTC timestamp of when they did, if not this will be empty.

timed_out: If the user is timed out, this will be the UTC timestamp of when they’ll be untimed-out, if not timed out this will be empty.

banner: The users banner url

Target Block

The {target} block follows the same usage and has the same attributes as the Author Block, but it defaults to the mentioned user in the tag invocation message if any users are mentioned, or the tag author.

Usage: {target}

Aliases: {member}

Channel Block

The {channel} block with no parameters returns the channel’s full name but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {channel([attribute])

Payload: None

Parameter: attribute, None

id: The channel’s ID.

name: The channel’s name.

created_at: The channel’s creation date.

timestamp: The channel’s creation date as a UTC timestamp.

nsfw: Whether the channel is nsfw.

mention: A formatted text that pings the channel.

topic: The channel’s topic.

category_id: The category the channel is associated with. If no category channel, this will return empty.

jump_url: A link to the channel.

.. versionchanged:: 3.2.0: Added jump_url as a parameter.

Server Block

The {server} block with no parameters returns the server’s name but passing the attributes listed below to the block payload will return that attribute instead.

Aliases: guild

Usage: {server([attribute])

Payload: None

Parameter: attribute, None

id: The server’s ID.

name: The server’s name.

icon: A link to the server’s icon, which can be used in embeds.

created_at: The server’s creation date.

timestamp: The server’s creation date as a UTC timestamp.

member_count: The server’s member count.

bots: The number of bots in the server.

humans: The number of humans in the server.

description: The server’s description if one is set, or “No description”.

random: A random member from the server.

vanity: If guild has a vanity, this returns the vanity else empty.

owner_id: The server owner’s id.

mfa: The server’s mfa level.

boosters: The server’s active booster count.

boost_level: The server’s current boost level/tier.

discovery_splash: A link to the server’s discovery splash.

invite_splash: A link to the server’s invite splash.

banner: A link to the server’s banner.

.. versionchanged:: 3.2.0: Added mfa, boosters, boost_level, discovery_splash, invite_splash & banner.