mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
3e80edcdfd
Well, the modlog examples had to be changed a lot, because `await` obviously won't work in regular method.
111 lines
2.7 KiB
ReStructuredText
111 lines
2.7 KiB
ReStructuredText
.. V3 Mod log
|
|
|
|
.. role:: python(code)
|
|
:language: python
|
|
|
|
|
|
=======
|
|
Mod log
|
|
=======
|
|
|
|
Mod log has now been separated from Mod for V3.
|
|
|
|
***********
|
|
Basic Usage
|
|
***********
|
|
|
|
.. code-block:: python
|
|
|
|
from redbot.core import commands, modlog
|
|
import discord
|
|
|
|
class MyCog(commands.Cog):
|
|
@commands.command()
|
|
@checks.admin_or_permissions(ban_members=True)
|
|
async def ban(self, ctx, user: discord.Member, reason: str = None):
|
|
await ctx.guild.ban(user)
|
|
case = await modlog.create_case(
|
|
ctx.bot, ctx.guild, ctx.message.created_at, action="ban",
|
|
user=user, moderator=ctx.author, reason=reason
|
|
)
|
|
await ctx.send("Done. It was about time.")
|
|
|
|
|
|
**********************
|
|
Registering Case types
|
|
**********************
|
|
|
|
To register case types, use an asynchronous ``initialize()`` method and call
|
|
it from your setup function:
|
|
|
|
.. code-block:: python
|
|
|
|
# mycog/mycog.py
|
|
from redbot.core import modlog, commands
|
|
import discord
|
|
|
|
class MyCog(commands.Cog):
|
|
|
|
async def initialize(self):
|
|
await self.register_casetypes()
|
|
|
|
@staticmethod
|
|
async def register_casetypes():
|
|
# Registering a single casetype
|
|
ban_case = {
|
|
"name": "ban",
|
|
"default_setting": True,
|
|
"image": "\N{HAMMER}",
|
|
"case_str": "Ban",
|
|
# audit_type should be omitted if the action doesn't show
|
|
# up in the audit log.
|
|
"audit_type": "ban",
|
|
}
|
|
try:
|
|
await modlog.register_casetype(**ban_case)
|
|
except RuntimeError:
|
|
pass
|
|
|
|
# Registering multiple casetypes
|
|
new_types = [
|
|
{
|
|
"name": "hackban",
|
|
"default_setting": True,
|
|
"image": "\N{BUST IN SILHOUETTE}\N{HAMMER}",
|
|
"case_str": "Hackban",
|
|
"audit_type": "ban",
|
|
},
|
|
{
|
|
"name": "kick",
|
|
"default_setting": True,
|
|
"image": "\N{WOMANS BOOTS}",
|
|
"case_str": "Kick",
|
|
"audit_type": "kick"
|
|
}
|
|
]
|
|
await modlog.register_casetypes(new_types)
|
|
|
|
.. code-block:: python
|
|
|
|
# mycog/__init__.py
|
|
from .mycog import MyCog
|
|
|
|
async def setup(bot):
|
|
cog = MyCog()
|
|
await cog.initialize()
|
|
bot.add_cog(cog)
|
|
|
|
.. important::
|
|
Image should be the emoji you want to represent your case type with.
|
|
|
|
|
|
*************
|
|
API Reference
|
|
*************
|
|
|
|
Mod log
|
|
=======
|
|
|
|
.. automodule:: redbot.core.modlog
|
|
:members:
|