Command Invocation Context¶

The purpose of this module is to allow for Red to further customise the command invocation context provided by discord.py.

class redbot.core.RedContext(**attrs)[source]¶

Command invocation context for Red.

All context passed into commands will be of this type.

This class inherits from commands.Context.

coroutine send_help() → typing.List[discord.message.Message][source]¶

Send the command help message.

Returns:	A list of help messages which were sent to the user.
Return type:	`list` of `discord.Message`

coroutine send_interactive(messages: typing.Iterable[str], box_lang: str = None, timeout: int = 15) → typing.List[discord.message.Message][source]¶

Send multiple messages interactively.

The user will be prompted for whether or not they would like to view the next message, one at a time. They will also be notified of how many messages are remaining on each prompt.

Parameters:	messages (`iterable` of `str`) – The messages to send. box_lang (str) – If specified, each message will be contained within a codeblock of this language. timeout (int) – How long the user has to respond to the prompt before it times out. After timing out, the bot deletes its prompt message.

coroutine tick() → bool[source]¶

Add a tick reaction to the command message.

Returns:	`True` if adding the reaction succeeded.
Return type:	bool