Checks

This section outlines all the available checks.

Note

These checks are for prefixed commands only.

discord_tools.max_usages(limit, bucket, *, hide_after_limit=False, disable_after_limit=False)

A decorator that adds a limit of usages to a command.

This decorator is for prefixed commands only, for an application commands version see tools.app_commands.max_usages().

Parameters:

• limit (int) – The amount of allowed usages before the command is no longer usable.

• bucket (discord.ext.commands.BucketType) – The bucket in which the usages are restricted by.

• hide_after_limit (bool) – Whether to set the discord.ext.commands.Command.hidden attribute to True after the limit is exhausted. Defaults to False. Only allowed if bucket is discord.ext.commands.BucketType.default.

• disable_after_limit (bool) – Whether to set the discord.ext.commands.Command.disabled attribute to True after the limit is exhausted. Defaults to False. Only allowed if bucket is discord.ext.commands.BucketType.default.

Return type:

Check[Context[Any]]

discord_tools.has_any_permissions(**perms)

A decorator that adds a permissions check.

Unlike discord.ext.commands.has_permissions(), discord.ext.commands.has_guild_permissions() this checks if the command invoker has any of the provided permissions.

Parameters:

**perms (bool) – The permissions to check for.

Return type:

Check[Context[Any]]

discord_tools.has_attachments(*, count=...)

A decorator that checks if the invoker message has any attachments.

Parameters:

count (int) – The amount of attachments the message should have for this check to pass successfully. Limit is 10.

Return type:

Check[Context[Any]]

discord_tools.has_voice_state()

A decorator that checks if the command invoker has a voice state (is in a voice channel).

Return type:

Check[Context[Any]]