`{user}` Tags

`{user.mention;user;allow_mention}`

Returns a string with a user mention.

Name	Type	Default	Description
`user`	User?	context User	The user to mention.
`allow_mention`	`boolean`	`true`	Whether to ping the user with this mention

`{user.id;user}`

Returns the ID of a user.

Name	Type	Default	Description
`user`	User?	context User	The user to get the ID of.

`{user.username;user}`

Returns the username of a user.

Name	Type	Default	Description
`user`	User?	context User	The user to get the username of.

`{user.bot;user}`

Returns a boolean whether a user is a bot account.

Name	Type	Default	Description
`user`	User?	context User	The user to check.

`{user.tag;user}`

Returns the tag of a user with the username and discriminator, for example DracoClaw#0065.

Name	Type	Default	Description
`user`	User?	context User	The user to get the tag of.

`{user.discriminator;user}`

Returns the discriminator of a user, which is the four digits at the end of the username.

Name	Type	Default	Description
`user`	User?	context user	The user to get the discriminator of.

`{user.avatar;user}`

Returns the avatar URL of a user. Their server avatar will take priority if they have one.

Name	Type	Default	Description
`user`	User?	context User	The user to get the avatar of.

`{user.roles;member}`

Returns an array of IDs for all the roles of a user.

Name	Type	Default	Description
`member`	Member?	context Member	The user to get the roles of.

{choose;{user.roles}} // A random role the user has

`{user.nickname;member}`

Returns the display name of a user. This will be their nickname if they have one set and their username otherwise.

Name	Type	Default	Description
`member`	Member?	context Member	The user to get the nickname of.

`{user.joinedAt;member}`

Returns a timestamp for the join date of a user that can be used with {time}.

Name	Type	Default	Description
`member`	Member?	context Member	The member to check.

`{user.createdAt;user}`

Returns a timestamp for the creation date of a user's Discord account that can be used with {time}.

Name	Type	Description
`user`	User?	The user to check.

`{user.edit nick mute deaf channel;member}`

Note

This tag is part of the Mutate User expensive group.

Edits a user.

Name	Type	Default	Description
`nick`	`string?`		The user's new nickname. Leave empty to clear.
`mute`	`boolean?`		Whether the user will be server muted in voice channels.
`deaf`	`boolean?`		Whether the user will be server deafened in voice channels.
`channel`	Channel?		The new channel to move the user to if they are in voice channel.
`member`	Member?	context Member	The user to edit.

`{user.addrole;role;member;reason}`

Note

This tag is part of the Mutate User expensive group. This tag is marked Dangerous and must be enabled in Advanced Settings.

Gives a user a role.

Name	Type	Default	Description
`role`	Role		The role to add to the user.
`member`	Member?	context Member	The user to give the role to.
`reason`	`string?`		The reason for the action.

`{user.removerole;role;member;reason}`

Note

This tag is part of the Mutate User expensive group.

Removes a role from a user.

Name	Type	Default	Description
`role`	Role		The role to remove from the user.
`member`	Member?	context Member	The user to remove the role from.
`reason`	`string?`		The reason for the action.

`{user.colour;member}`

Gets a user's colour based on their highest non-default (#99aab5) role.

Name	Type	Default	Description
`member`	Member?	context Member	The Member to check.

`{user.hasPermission;permissions;member}`

Checks whether a user has the given permissions.

Name	Type	Default	Description
`permissions`	`bigint`		The permission to check for. Can be a permissions number or name (e.g. `create_instant_invite`)
`member`	Member?	context Member	The member to check the permissions of.

A full list of permissions can be seen here.

`{user.level;user}`

Gets the level of a user.

Name	Type	Default	Description
`user`	User?	context User	The user to get the level of.

`{user.xp;user;scoped}`

Name	Type	Default	Description
`user`	User?	context User	The user to get the XP of.
`scoped`	`boolean`	`false`	Whether to get XP on the current level or total XP. The default is total XP.

`{user.setXP;xp;target;add;sync}`

Note

This tag is part of the Mutate User expensive group.

Sets the users XP to the given amount.

Name	Type	Default	Description
`xp`	`number`		The amount of XP to set.
`target`	User?	context User	The user to set the XP of.
`add`	`boolean`	`false`	Whether to add the XP to their existing total.
`sync`	`boolean`	`false`	Whether to sync level rewards for the user.

`{user.setLevel;level;target;add;sync}`

Note

This tag is part of the Mutate User expensive group.

Sets the users level to the given amount.

Name	Type	Default	Description
`level`	`number`		The amount of levels to set
`target`	User?	context User	The user to set the level of.
`add`	`boolean`	`false`	Whether to add the levels to their existing total.
`sync`	`boolean`	`false`	Whether to sync level rewards for the user.

`{user.nextLevel;user}`

Gets the next level the user will become.

Name	Type	Default	Description
`user`	User?	context User	The user to get the next level of.

`{user.nextLevelXP;user}`

Get the XP required for the users next level.

Name	Type	Default	Description
`user`	User?	context User	The user to get the next level XP of.

`{user.remainingXP;user}`

Gets the amount of XP a user needs to level up to the next level.

Name	Type	Default	Description
`user`	User?	context User	The user to get the remaining XP of.

`{user.rank;user}`

Gets the rank of a user.

Name	Type	Default	Description
`user`	User?	context User	The user to get the rank of.

`{user.reward;filter;first;raw}`

Returns the reward the user achieved by levelling up. Returns nothing if there was no reward. This tag is only available in level-up scripts and cannot be used elsewhere.

Name	Type	Default	Description
`filter`	`string`	`achieved`	The kind of reward to return. One of `achieved`, `entitled`, `added`, `removed`, `existing`.
`first`	`boolean`	`true`	Whether to return only the first reward in the filtered list. Some levels can have multiple rewards.
`raw`	`boolean`	`false`	Whether to return a raw rewards object with more information about the reward. The object looks something like `{ level, roleId, stack }`

As an example, you could set your level-up notification to this

{if;{user.reward};Congratulations {user.mention}! You levelled up to level {user.level} and got the {role.mention allow_mention=false;{user.reward}} role!}

Which would send a level-up message only if the user got a new role.

`{user.kick;target;reason;noDM;returnCaseId;moderator}`

Kicks a user from the server.

Name	Type	Default	Description
`target`	User		The user to kick.
`reason`	`string`		The reason for the kick.
`noDM`	`boolean`	`false`	Whether to send the user a DM about the kick.
`returnCaseId`	`boolean`	`false`	Whether to return the case ID of the kick.
`moderator`	User?	bot user	The moderator who is kicking.

`{user.ban;target;reason;noDM;purgeDays;returnCaseId;moderator;duration}`

Bans a user from the server.

Name	Type	Default	Description
`target`	User		The user to ban.
`reason`	`string`		The reason for the ban.
`noDM`	`boolean`	`false`	Whether to send the user a DM about the ban.
`purgeDays`	`number`	`0`	The number of days of messages to delete from the user.
`returnCaseId`	`boolean`	`false`	Whether to return the case ID of the ban.
`moderator`	User?	bot user	The moderator that bans the user.
`duration`	`number?`	permanent	The duration of the ban in milliseconds.

`{user.warn;target;reason;noDM;returnCaseId;moderator;duration}`

Warns a user.

Name	Type	Default	Description
`target`	User		The user to warn.
`reason`	`string`		The reason for the warn.
`noDM`	`boolean`	`false`	Whether to send the user a DM about the warn.
`returnCaseId`	`boolean`	`false`	Whether to return the case ID of the warn.
`moderator`	User?	bot user	The moderator who is warning.
`duration`	`string?`		The duration of the warn (ex `1d`), permanent by default.

`{user.caseCount;member;type}`

Gets the amount of cases a user has.

Name	Type	Default	Description
`member`	Member?	context Member	The member to get case count from.
`type`	`string?`		The type of cases to count. One of `Mute`, `Unmute`, `Kick`, `Ban`, `Unban`, `Warning`.

`{user.setRoles;roles;member}`

Note

This tag is part of the Bulk Edit expensive group.

Sets the roles of a user.

Name	Type	Default	Description
`roles`	Role[]		An array of roles to set for the user.
`member`	Member?	context Member	The member to set the roles of.

Tags

{user} Tags

`{user}` Tags