Syntax

$changeUsername[newName]

Parameters

Parameter	Description
newName	Required. The new nickname. After substitution it must contain 1 to 32 characters, otherwise the error Nickname must contain 1 to 32 characters. is raised (an empty value is therefore an error). The text %username% is replaced by the username of the target user.

Return value

None (empty string).

Behavior

• Target: first user mention of the message, otherwise the author. If no valid user ID can be determined, the error Missing or invalid user ID. is raised.
• %username% in newName is replaced by the target’s username (error User not found: <id>. if the user cannot be found).
• The change is applied like $setNickname (the bot needs Manage Nicknames; if Discord refuses the change, an error is raised).

Examples

Rename the mentioned member

$changeUsername[Gentle Member]
$sendMessage[Nickname changed.]

Keep the username with a prefix

$changeUsername[[Member] %username%]
$sendMessage[Nickname updated.]

Notes

• Only the nickname on the current server is changed; the global account name is never modified.
• Use $changeUsernameWithID[userID;newName] to name the target by ID, or $setNickname[nickname;(userID)] which also accepts an empty nickname.