mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 12:18:59 +00:00
Code Issues Projects Releases Wiki Activity

Add examples for new cooldown checks

Browse Source
This commit is contained in:
Rapptz 2022-03-29 06:00:20 -04:00
parent 55695dab3c
commit b7b992375d
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
discord/app_commands/checks.py
View File

@ -432,6 +432,23 @@ def cooldown(
If a cooldown is triggered, then :exc:`~discord.app_commands.CommandOnCooldown` is If a cooldown is triggered, then :exc:`~discord.app_commands.CommandOnCooldown` is
raised to the error handlers. raised to the error handlers.
Examples
---------
Setting a one per 5 seconds per member cooldown on a command:
.. code-block:: python3
@tree.command()
@app_commands.checks.cooldown(1, 5.0, key=lambda i: (i.guild_id, i.user.id))
async def test(interaction: discord.Interaction):
await interaction.response.send_message('Hello')
@test.error
async def on_test_error(interaction: discord.Interaction, error: app_commands.AppCommandError):
if isinstance(error, app_commands.CommandOnCooldown):
await interaction.response.send_message(str(error), ephemeral=True)
Parameters Parameters
------------ ------------
rate: :class:`int` rate: :class:`int`
@ -480,6 +497,28 @@ def dynamic_cooldown(
If a cooldown is triggered, then :exc:`~discord.app_commands.CommandOnCooldown` is If a cooldown is triggered, then :exc:`~discord.app_commands.CommandOnCooldown` is
raised to the error handlers. raised to the error handlers.
Examples
---------
Setting a cooldown for everyone but the owner.
.. code-block:: python3
def cooldown_for_everyone_but_me(interaction: discord.Interaction) -> Optional[app_commands.Cooldown]:
if interaction.user.id == 80088516616269824:
return None
return app_commands.Cooldown(1, 10.0)
@tree.command()
@app_commands.checks.dynamic_cooldown(cooldown_for_everyone_but_me)
async def test(interaction: discord.Interaction):
await interaction.response.send_message('Hello')
@test.error
async def on_test_error(interaction: discord.Interaction, error: app_commands.AppCommandError):
if isinstance(error, app_commands.CommandOnCooldown):
await interaction.response.send_message(str(error), ephemeral=True)
Parameters Parameters
------------ ------------
factory: Optional[Callable[[:class:`discord.Interaction`], Optional[:class:`~discord.app_commands.Cooldown`]]] factory: Optional[Callable[[:class:`discord.Interaction`], Optional[:class:`~discord.app_commands.Cooldown`]]]