matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

[commands] Add role cooldown bucket

Browse Source
This commit is contained in:
BluePhoenixGame 2019-08-12 00:44:16 +02:00 committed by Danny
parent 12343c1422
commit c7d3ebb400
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
discord/ext/commands/cooldowns.py
View File

@ -27,6 +27,8 @@ DEALINGS IN THE SOFTWARE.
from discord.enums import Enum from discord.enums import Enum
import time import time
from ...abc import PrivateChannel
__all__ = ( __all__ = (
'BucketType', 'BucketType',
'Cooldown', 'Cooldown',
@ -40,6 +42,7 @@ class BucketType(Enum):
channel = 3 channel = 3
member = 4 member = 4
category = 5 category = 5
role = 6
class Cooldown: class Cooldown:
__slots__ = ('rate', 'per', 'type', '_window', '_tokens', '_last') __slots__ = ('rate', 'per', 'type', '_window', '_tokens', '_last')
@ -127,6 +130,12 @@ class CooldownMapping:
return ((msg.guild and msg.guild.id), msg.author.id) return ((msg.guild and msg.guild.id), msg.author.id)
elif bucket_type is BucketType.category: elif bucket_type is BucketType.category:
return (msg.channel.category or msg.channel).id return (msg.channel.category or msg.channel).id
elif bucket_type is BucketType.role:
# we return the channel id of a private-channel as there are only roles in guilds
# and that yields the same result as for a guild with only the @everyone role
# NOTE: PrivateChannel doesn't actually have an id attribute but we assume we are
# recieving a DMChannel or GroupChannel which inherit from PrivateChannel and do
return (msg.channel if isinstance(msg.channel, PrivateChannel) else msg.author.top_role).id
def _verify_cache_integrity(self, current=None): def _verify_cache_integrity(self, current=None):
# we want to delete all cache objects that haven't been used # we want to delete all cache objects that haven't been used

3
discord/ext/commands/core.py
View File

@ -1592,7 +1592,7 @@ def cooldown(rate, per, type=BucketType.default):
A cooldown allows a command to only be used a specific amount A cooldown allows a command to only be used a specific amount
of times in a specific time frame. These cooldowns can be based of times in a specific time frame. These cooldowns can be based
either on a per-guild, per-channel, per-user, or global basis. either on a per-guild, per-channel, per-user, per-role or global basis.
Denoted by the third argument of ``type`` which must be of enum Denoted by the third argument of ``type`` which must be of enum
type ``BucketType`` which could be either: type ``BucketType`` which could be either:
@ -1602,6 +1602,7 @@ def cooldown(rate, per, type=BucketType.default):
- ``BucketType.channel`` for a per-channel basis. - ``BucketType.channel`` for a per-channel basis.
- ``BucketType.member`` for a per-member basis. - ``BucketType.member`` for a per-member basis.
- ``BucketType.category`` for a per-category basis. - ``BucketType.category`` for a per-category basis.
- ``BucketType.role`` for a per-role basis.
If a cooldown is triggered, then :exc:`.CommandOnCooldown` is triggered in If a cooldown is triggered, then :exc:`.CommandOnCooldown` is triggered in
:func:`.on_command_error` and the local error handler. :func:`.on_command_error` and the local error handler.