Skip to content

Madlibs - Add "End Game" and "Choose for me" buttons #1690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Madlibs - Add "End Game" and "Choose for me" buttons #1690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 164 additions & 13 deletions bot/exts/fun/madlibs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import asyncio
import json
from pathlib import Path
from random import choice
Expand All @@ -9,11 +10,11 @@
from bot.bot import Bot
from bot.constants import Colours, NEGATIVE_REPLIES

TIMEOUT = 60.0
TIMEOUT = 120


class MadlibsTemplate(TypedDict):
"""Structure of a template in the madlibs JSON file."""
"""Structure of a template in the madlibs_templates JSON file."""

title: str
blanks: list[str]
Expand All @@ -27,6 +28,10 @@ def __init__(self, bot: Bot):
self.bot = bot
self.templates = self._load_templates()
self.edited_content = {}
self.submitted_words = {}
self.view = None
self.wait_task: asyncio.Task | None = None
self.end_game = False
self.checks = set()

@staticmethod
Expand All @@ -43,7 +48,9 @@ def madlibs_embed(part_of_speech: str, number_of_inputs: int) -> discord.Embed:

madlibs_embed.add_field(
name="Enter a word that fits the given part of speech!",
value=f"Part of speech: {part_of_speech}\n\nMake sure not to spam, or you may get auto-muted!"
value=f"Part of speech: {part_of_speech}\n\nMake sure not to spam, or you may get auto-muted!\n\n"
f"Note: You'll be able to use the 'Choose for me' button\none minute after each new part "
f"of speech appears."
)

madlibs_embed.set_footer(text=f"Inputs remaining: {number_of_inputs}")
Expand Down Expand Up @@ -73,8 +80,15 @@ async def madlibs(self, ctx: commands.Context) -> None:
"""
random_template = choice(self.templates)

self.end_game = False

def author_check(message: discord.Message) -> bool:
return message.channel.id == ctx.channel.id and message.author.id == ctx.author.id
if message.channel.id != ctx.channel.id or message.author.id != ctx.author.id:
return False

# Ignore commands while a game is running
prefix = ctx.prefix or ""
return not (prefix and message.content.startswith(prefix))

self.checks.add(author_check)

Expand All @@ -83,17 +97,49 @@ def author_check(message: discord.Message) -> bool:
)
original_message = await ctx.send(embed=loading_embed)

submitted_words = {}

for i, part_of_speech in enumerate(random_template["blanks"]):
inputs_left = len(random_template["blanks"]) - i

if self.view and getattr(self.view, "cooldown_task", None) and not self.view.cooldown_task.done():
self.view.cooldown_task.cancel()

self.view = MadlibsView(ctx, self, 60, part_of_speech, i)

madlibs_embed = self.madlibs_embed(part_of_speech, inputs_left)
await original_message.edit(embed=madlibs_embed)
await original_message.edit(embed=madlibs_embed, view=self.view)

self.view.cooldown_task = asyncio.create_task(self.view.enable_random_button_after(original_message))

self.wait_task = asyncio.create_task(
self.bot.wait_for("message", timeout=TIMEOUT, check=author_check)
)
try:
message = await self.bot.wait_for("message", check=author_check, timeout=TIMEOUT)
message = await self.wait_task
self.submitted_words[i] = message.content
except asyncio.CancelledError:
if self.end_game:
if self.view:
self.view.stop()
for child in self.view.children:
if isinstance(child, discord.ui.Button):
child.disabled = True

# cancel cooldown cleanly
task = getattr(self.view, "cooldown_task", None)
if task and not task.done():
task.cancel()

await original_message.edit(view=self.view)
self.checks.remove(author_check)

return
# else: "Choose for me" set self.submitted_words[i]; just continue
except TimeoutError:
# If we ended the game around the same time, don't show timeout
if self.end_game:
self.checks.remove(author_check)
return

timeout_embed = discord.Embed(
title=choice(NEGATIVE_REPLIES),
description="Uh oh! You took too long to respond!",
Expand All @@ -102,16 +148,24 @@ def author_check(message: discord.Message) -> bool:

await ctx.send(ctx.author.mention, embed=timeout_embed)

for msg_id in submitted_words:
self.edited_content.pop(msg_id, submitted_words[msg_id])
self.view.stop()
for child in self.view.children:
if isinstance(child, discord.ui.Button):
child.disabled = True

await original_message.edit(view=self.view)

for j in self.submitted_words:
self.edited_content.pop(j, self.submitted_words[j])

self.checks.remove(author_check)

return
finally:
# Clean up so the next iteration doesn't see an old task
self.wait_task = None

submitted_words[message.id] = message.content

blanks = [self.edited_content.pop(msg_id, submitted_words[msg_id]) for msg_id in submitted_words]
blanks = [self.submitted_words[j] for j in range(len(random_template["blanks"]))]

self.checks.remove(author_check)

Expand All @@ -134,6 +188,20 @@ def author_check(message: discord.Message) -> bool:

await ctx.send(embed=story_embed)

# After sending the story, disable the view and cancel all wait tasks
if self.view:
task = getattr(self.view, "cooldown_task", None)
if task and not task.done():
task.cancel()
self.view.stop()
for child in self.view.children:
if isinstance(child, discord.ui.Button):
child.disabled = True
await original_message.edit(view=self.view)

if self.wait_task and not self.wait_task.done():
self.wait_task.cancel()

@madlibs.error
async def handle_madlibs_error(self, ctx: commands.Context, error: commands.CommandError) -> None:
"""Error handler for the Madlibs command."""
Expand All @@ -142,6 +210,89 @@ async def handle_madlibs_error(self, ctx: commands.Context, error: commands.Comm
error.handled = True


class MadlibsView(discord.ui.View):
"""A set of buttons to control a Madlibs game."""

def __init__(self, ctx: commands.Context, cog: "Madlibs", cooldown: float = 0,
part_of_speech: str = "", index: int = 0):
super().__init__(timeout=120)
self.disabled = None
self.ctx = ctx
self.cog = cog
self.word_bank = self._load_word_bank()
self.part_of_speech = part_of_speech
self.index = index
self._cooldown = cooldown

# Reference to the async task that will re-enable the button
self.cooldown_task: asyncio.Task | None = None

if cooldown > 0:
self.random_word_button.disabled = True

async def enable_random_button_after(self, message: discord.Message) -> None:
"""Function that controls the cooldown of the "Choose for me" button to prevent spam."""
if self._cooldown <= 0:
return
await asyncio.sleep(self._cooldown)

# Game ended or this view is no longer the active one
if self.is_finished() or self is not self.cog.view:
return

self.random_word_button.disabled = False
await message.edit(view=self)

@staticmethod
def _load_word_bank() -> dict[str, list[str]]:
word_bank = Path("bot/resources/fun/madlibs_word_bank.json")

with open(word_bank) as file:
return json.load(file)

@discord.ui.button(style=discord.ButtonStyle.green, label="Choose for me")
async def random_word_button(self, interaction: discord.Interaction, *_) -> None:
"""Button that randomly chooses a word for the user if they cannot think of a word."""
if interaction.user == self.ctx.author:
random_word = choice(self.word_bank[self.part_of_speech])
self.cog.submitted_words[self.index] = random_word

wait_task = getattr(self.cog, "wait_task", None)
if wait_task and not wait_task.done():
wait_task.cancel()

if self.cooldown_task and not self.cooldown_task.done():
self.cooldown_task.cancel()

await interaction.response.send_message(f"Randomly chosen word: {random_word}", ephemeral=True)

# Re-disable the button and restart the cooldown (so it can't be clicked again immediately)
self.random_word_button.disabled = True
await interaction.followup.edit_message(view=self)
else:
await interaction.response.send_message("Only the owner of the game can end it!", ephemeral=True)

@discord.ui.button(style=discord.ButtonStyle.red, label="End Game")
async def end_button(self, interaction: discord.Interaction, *_) -> None:
"""Button that ends the current game."""
if interaction.user == self.ctx.author:
# Cancel the wait task if it's running
self.cog.end_game = True
wait_task = getattr(self.cog, "wait_task", None)
if wait_task and not wait_task.done():
wait_task.cancel()

# Disable all buttons in the view
for child in self.children:
if isinstance(child, discord.ui.Button):
child.disabled = True

await interaction.response.send_message("Ended the current game.", ephemeral=True)
await interaction.followup.edit_message(message_id=interaction.message.id, view=self)
else:
await interaction.response.send_message("Only the owner of the game can end it!", ephemeral=True)


async def setup(bot: Bot) -> None:
"""Load the Madlibs cog."""
await bot.add_cog(Madlibs(bot))
Loading