mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
d8e780b228
* Add 3.4.0 changelog * Fix some stuff in previous changelog - Remove empty section - Fix alphabetical order in contributor list - Add missing Flame to contributor list - Fix the length of rst header underline * PR 4050 * PR 3993 * PR 4064 (issue 4028) * PR 4077 * PR 3956 * PR 4079 * PR 4089 (issue 4088) Co-Authored-By: Dav <dav@mail.stopdavabuse.de> * PR 4099 * PR 4097 * Add Trusty to contributor list * PR 4116 * PR 4043 (issue 3945) * PR 4072 * PR 4109 * PR 4110 * PR 4102 * PR 4112 * PR 4161 * PR 4121 * PR 4134, 4143 * PR 4085 * PR 2982 (issue 2906) * PR 3679 (issue 3605) * PR 4148 (issue 4147) * PR 4011 * PR 4022 (issue 4013) * PR 4135 (issue 4122) * PR 4167 * PR 4141 * Add NeuroAssassin to contributor list * PR 4129 * PR 4149 * PR 4105, 4127 (issue 4106) * PR 3845 * PR 4142 * PR 4163 * PR 4176 * PR 4172 (issue 4066) * PR 4038 (issue 3786) * PR 3081 * PR 4137 (issue 4118) * PR 4017 * PR 4182 Co-Authored-By: Dav <dav@mail.stopdavabuse.de> * Add Kowlin to contributor list * PR 4182 * PR 4169 * PR 3084 * Add `douglas-cpp`, `MeatyChunks`, `zephyrkul` to contributor list * PR 4138 * Add some anchor * Add release date Co-authored-by: Dav <dav@mail.stopdavabuse.de> Co-authored-by: palmtree5 <3577255+palmtree5@users.noreply.github.com>
64 lines
1.6 KiB
ReStructuredText
64 lines
1.6 KiB
ReStructuredText
.. red commands module documentation
|
|
|
|
================
|
|
Commands Package
|
|
================
|
|
|
|
This package acts almost identically to :doc:`discord.ext.commands <dpy:ext/commands/api>`; i.e.
|
|
all of the attributes from discord.py's are also in ours.
|
|
Some of these attributes, however, have been slightly modified, while others have been added to
|
|
extend functionalities used throughout the bot, as outlined below.
|
|
|
|
.. autofunction:: redbot.core.commands.command
|
|
|
|
.. autofunction:: redbot.core.commands.group
|
|
|
|
.. autoclass:: redbot.core.commands.Cog
|
|
|
|
.. automethod:: format_help_for_context
|
|
|
|
.. automethod:: red_get_data_for_user
|
|
|
|
.. automethod:: red_delete_data_for_user
|
|
|
|
.. autoclass:: redbot.core.commands.Command
|
|
:members:
|
|
:inherited-members: format_help_for_context
|
|
|
|
.. autoclass:: redbot.core.commands.Group
|
|
:members:
|
|
|
|
.. autoclass:: redbot.core.commands.Context
|
|
:members:
|
|
|
|
.. autoclass:: redbot.core.commands.GuildContext
|
|
|
|
.. autoclass:: redbot.core.commands.DMContext
|
|
|
|
.. automodule:: redbot.core.commands.requires
|
|
:members: PrivilegeLevel, PermState, Requires
|
|
|
|
.. automodule:: redbot.core.commands.converter
|
|
:members:
|
|
:exclude-members: UserInputOptional, convert
|
|
:no-undoc-members:
|
|
|
|
.. autodata:: UserInputOptional
|
|
:annotation:
|
|
|
|
.. _framework-commands-help:
|
|
|
|
******************
|
|
Help Functionality
|
|
******************
|
|
|
|
.. warning::
|
|
|
|
The content in this section is provisional and may change
|
|
without prior notice or warning. Updates to this will be communicated
|
|
on `this issue <https://github.com/Cog-Creators/Red-DiscordBot/issues/4084>`_
|
|
|
|
|
|
.. automodule:: redbot.core.commands.help
|
|
:members:
|