Skip to content

tux.cogs.moderation.clearafk

Classes:

Name Description
ClearAFK

Classes

ClearAFK(bot: Tux)

Bases: Cog

Methods:

Name Description
clear_afk

Clear a member's AFK status and reset their nickname.
Source code in tux/cogs/moderation/clearafk.py
Python
def __init__(self, bot: Tux) -> None:
    self.bot = bot
    self.db = AfkController()
    self.clear_afk.usage = "clearafk <member>"

Functions

clear_afk(ctx: commands.Context[Tux], member: discord.Member) -> discord.Message async

Clear a member's AFK status and reset their nickname.

Parameters:

Name Type Description Default
ctx Context[Tux]

The context in which the command is being invoked.

 required
member Member

The member whose AFK status is to be cleared.

 required
Source code in tux/cogs/moderation/clearafk.py
Python
@commands.hybrid_command(
    name="clearafk",
    aliases=["cafk", "removeafk"],
    description="Clear a member's AFK status and reset their nickname.",
)
@commands.guild_only()
@checks.has_pl(2)  # Ensure the user has the required permission level
async def clear_afk(
    self,
    ctx: commands.Context[Tux],
    member: discord.Member,
) -> discord.Message:
    """
    Clear a member's AFK status and reset their nickname.

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context in which the command is being invoked.
    member : discord.Member
        The member whose AFK status is to be cleared.
    """

    assert ctx.guild

    if not await self.db.is_afk(member.id, guild_id=ctx.guild.id):
        return await ctx.send(f"{member.mention} is not currently AFK.", ephemeral=True)

    # Fetch the AFK entry to retrieve the original nickname
    entry = await self.db.get_afk_member(member.id, guild_id=ctx.guild.id)

    await self.db.remove_afk(member.id)

    if entry:
        if entry.nickname:
            with contextlib.suppress(discord.Forbidden):
                await member.edit(nick=entry.nickname)  # Reset nickname to original
        if entry.enforced:  # untimeout the user if  the afk status is a self-timeout
            await member.timeout(None, reason="removing self-timeout")

    return await ctx.send(f"AFK status for {member.mention} has been cleared.", ephemeral=True)