Command Check Decorators

The following are all decorators for commands, which add restrictions to where and when they can be run.

redbot.core.checks.admin()[source]

Restrict the command to users with the admin role.

This check can be overridden by rules.

redbot.core.checks.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.checks.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.checks.bot_in_a_guild()[source]

Deny the command if the bot is not in a guild.

redbot.core.checks.guildowner()[source]

Restrict the command to the guild owner.

This check can be overridden by rules.

redbot.core.checks.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.checks.has_permissions(**perms)[source]

Restrict the command to users with these permissions.

This check can be overridden by rules.

redbot.core.checks.is_owner()[source]

Restrict the command to bot owners.

This check cannot be overridden by rules.

redbot.core.checks.mod()[source]

Restrict the command to users with the mod role.

This check can be overridden by rules.

redbot.core.checks.mod_or_permissions(**perms)[source]

Restrict the command to users with the mod role or these permissions.

This check can be overridden by rules.