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

[commands] Change prefix callback signature and add when_mentioned.

Browse Source 
The utility allows for easy addition of "when the bot is mentioned"
as the prefix. The change of signature was to facilitate this.
This commit is contained in:
Rapptz 2016-01-08 19:40:00 -05:00
parent af94179be5
commit 52eb0e3adb
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
discord/ext/commands/__init__.py
View File

@ -10,7 +10,7 @@ An extension module to facilitate creation of bot commands.
:license: MIT, see LICENSE for more details.
"""
from .bot import Bot
from .bot import Bot, when_mentioned
from .context import Context
from .core import *
from .errors import *

14
discord/ext/commands/bot.py
View File

@ -33,6 +33,11 @@ from .view import StringView
from .context import Context
from .errors import CommandNotFound
def when_mentioned(bot, msg):
"""A callable that implements a command prefix equivalent
to being mentioned, e.g. ``@bot ``."""
return '{0.user.mention} '.format(bot)
class Bot(GroupMixin, discord.Client):
"""Represents a discord bot.
@ -48,9 +53,10 @@ class Bot(GroupMixin, discord.Client):
command_prefix
The command prefix is what the message content must contain initially
to have a command invoked. This prefix could either be a string to
indicate what the prefix should be, or a callable that takes in a
:class:`discord.Message` as its first parameter and returns the prefix.
This is to facilitate "dynamic" command prefixes.
indicate what the prefix should be, or a callable that takes in the bot
as its first parameter and :class:`discord.Message` as its second
parameter and returns the prefix. This is to facilitate "dynamic"
command prefixes.
The command prefix could also be a list or a tuple indicating that
multiple checks for the prefix should be used and the first one to
@ -71,7 +77,7 @@ class Bot(GroupMixin, discord.Client):
def _get_prefix(self, message):
prefix = self.command_prefix
if callable(prefix):
return prefix(message)
return prefix(self, message)
else:
return prefix