Command Check Decorators¶
The following are all decorators for commands, which add restrictions to where and when they can be run.
-
redbot.core.commands.
admin
()[source]¶ Restrict the command to users with the admin role.
This check can be overridden by rules.
-
redbot.core.commands.
admin_or_permissions
(**perms)[source]¶ Restrict the command to users with the admin role or these permissions.
This check can be overridden by rules.
-
redbot.core.commands.
bot_has_permissions
(**perms)[source]¶ Complain if the bot is missing permissions.
If the user tries to run the command, but the bot is missing the permissions, it will send a message describing which permissions are missing.
This check cannot be overridden by rules.
-
redbot.core.commands.
guildowner
()[source]¶ Restrict the command to the guild owner.
This check can be overridden by rules.
-
redbot.core.commands.
guildowner_or_permissions
(**perms)[source]¶ Restrict the command to the guild owner or users with these permissions.
This check can be overridden by rules.
-
redbot.core.commands.
has_guild_permissions
(**perms)[source]¶ Restrict the command to users with these guild permissions.
This check can be overridden by rules.
-
redbot.core.commands.
has_permissions
(**perms)[source]¶ Restrict the command to users with these permissions.
This check can be overridden by rules.
-
redbot.core.commands.
is_owner
()[source]¶ Restrict the command to bot owners.
This check cannot be overridden by rules.
-
redbot.core.commands.
mod
()[source]¶ Restrict the command to users with the mod role.
This check can be overridden by rules.
-
redbot.core.commands.
mod_or_permissions
(**perms)[source]¶ Restrict the command to users with the mod role or these permissions.
This check can be overridden by rules.
-
redbot.core.commands.
permissions_check
(predicate)[source]¶ An overwriteable version of
discord.ext.commands.check
.This has the same behaviour as
discord.ext.commands.check
, however this check can be ignored if the command is allowed through a permissions cog.