Syntax

$mute[roleName]

Parameters

Parameter	Description
roleName	Required. The exact name of the role to grant (case-sensitive). An error is raised if no role has this name.

Return Value

None. The role is added to each mentioned user.

Behavior

• The users are taken from the user mentions of the command message. If the message mentions no user, an error is raised (the author is never used as a fallback).
• The role is looked up by exact name among the roles of the server.
• If no role has this name, the error Role not found: <name>. is raised.
• The bot must have Manage Roles and the role must be below the bot’s highest role; @everyone and managed (bot, integration, booster) roles cannot be granted. Otherwise a permission error is raised.
• There is no reason parameter: $mute accepts exactly one argument.

Examples

Simple Mute

$mute[Muted]
$sendMessage[<@$mentioned[1;no]> was muted.]

Verification before mute

$if[$isAdmin[$authorID]==true]
  $mute[Muted]
  $sendMessage[Member muted.]
$else
  $sendMessage[Permission denied.]
$endif

Notes

• Create beforehand a role (here Muted) whose permissions prevent speaking or writing, and keep its name identical to the one passed to $mute.
• To remove the role again, use $unmute[roleName].
• For a temporary timeout, use $timeout.
• $mute has no ID argument: it reads the user mentions of the message, so it does not work in a slash command (no mention). For a slash command, use $giveRole[$message[member];roleID] with the ID of a user option (see $message). In prefix guards, write $mentioned[1;no].