Moderation
unTimeout
$unTimeout
The function $unTimeout removes the timeout of a user before its expiration, restoring their ability to send messages and speak in voice. The bot must have the ModerateMembers permission.
Syntax
$unTimeout[(userID)]
Parameters
| Parameter | Description |
|---|---|
userID |
Optional - The ID of the user to free from timeout (must be a positive number, otherwise the error Missing or invalid user ID. is raised). If omitted or empty, every user mentioned in the message is used (each distinct mention is processed); if there is no mention either, the error A user ID or user mention is required. is raised. |
Return Value
None (empty string). An error is raised if the user ID is invalid, or if the bot cannot remove the timeout: the bot needs the ModerateMembers permission, and the operation is refused when the target is the server owner, an administrator, or has a highest role equal to or above the bot’s.
Examples
Simple removal
$unTimeout[$mentioned[1;no]]
$sendMessage[✅ <@$mentioned[1;no]> is no longer in timeout.]
Conditional removal
$if[$isTimedOut[$mentioned[1;no]]==true]
$unTimeout[$mentioned[1;no]]
$sendMessage[Timeout removed.]
$else
$sendMessage[This user is not in timeout.]
$endif
Pardon command
$unTimeout[$mentioned[1;no]]
$sendMessage[🙏 Pardon granted. <@$mentioned[1;no]> can participate again.]
Notes
- The bot must have the
ModerateMemberspermission (or Administrator). The server owner, administrators and members whose highest role is equal to or above the bot’s highest role cannot be targeted. - Use
$isTimedOutto check if a user is in timeout before calling$unTimeout. - In a slash command there are no mentions: pass the ID explicitly,
$unTimeout[$message[member]]($message[member]is the ID of auseroption, see$message). Without an ID,A user ID or user mention is required.is raised. In prefix guards, write$mentioned[1;no].
Try it
Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.