# This example requires the 'message_content' privileged intent to function. from __future__ import annotations from discord.ext import commands import discord import re # Define a simple View that persists between bot restarts # In order for a view to persist between restarts it needs to meet the following conditions: # 1) The timeout of the View has to be set to None # 2) Every item in the View has to have a custom_id set # It is recommended that the custom_id be sufficiently unique to # prevent conflicts with other buttons the bot sends. # For this example the custom_id is prefixed with the name of the bot. # Note that custom_ids can only be up to 100 characters long. class PersistentView(discord.ui.View): def __init__(self): super().__init__(timeout=None) @discord.ui.button(label='Green', style=discord.ButtonStyle.green, custom_id='persistent_view:green') async def green(self, interaction: discord.Interaction, button: discord.ui.Button): await interaction.response.send_message('This is green.', ephemeral=True) @discord.ui.button(label='Red', style=discord.ButtonStyle.red, custom_id='persistent_view:red') async def red(self, interaction: discord.Interaction, button: discord.ui.Button): await interaction.response.send_message('This is red.', ephemeral=True) @discord.ui.button(label='Grey', style=discord.ButtonStyle.grey, custom_id='persistent_view:grey') async def grey(self, interaction: discord.Interaction, button: discord.ui.Button): await interaction.response.send_message('This is grey.', ephemeral=True) # More complicated cases might require parsing state out from the custom_id instead. # For this use case, the library provides a `DynamicItem` to make this easier. # The same constraints as above apply to this too. # For this example, the `template` class parameter is used to give the library a regular # expression to parse the custom_id with. # These custom IDs will be in the form of e.g. `button:user:80088516616269824`. class DynamicButton(discord.ui.DynamicItem[discord.ui.Button], template=r'button:user:(?P[0-9]+)'): def __init__(self, user_id: int) -> None: super().__init__( discord.ui.Button( label='Do Thing', style=discord.ButtonStyle.blurple, custom_id=f'button:user:{user_id}', emoji='\N{THUMBS UP SIGN}', ) ) self.user_id: int = user_id # This is called when the button is clicked and the custom_id matches the template. @classmethod async def from_custom_id(cls, interaction: discord.Interaction, item: discord.ui.Button, match: re.Match[str], /): user_id = int(match['id']) return cls(user_id) async def interaction_check(self, interaction: discord.Interaction) -> bool: # Only allow the user who created the button to interact with it. return interaction.user.id == self.user_id async def callback(self, interaction: discord.Interaction) -> None: await interaction.response.send_message('This is your very own button!', ephemeral=True) class PersistentViewBot(commands.Bot): def __init__(self): intents = discord.Intents.default() intents.message_content = True super().__init__(command_prefix=commands.when_mentioned_or('$'), intents=intents) async def setup_hook(self) -> None: # Register the persistent view for listening here. # Note that this does not send the view to any message. # In order to do this you need to first send a message with the View, which is shown below. # If you have the message_id you can also pass it as a keyword argument, but for this example # we don't have one. self.add_view(PersistentView()) # For dynamic items, we must register the classes instead of the views. self.add_dynamic_items(DynamicButton) async def on_ready(self): print(f'Logged in as {self.user} (ID: {self.user.id})') print('------') bot = PersistentViewBot() @bot.command() @commands.is_owner() async def prepare(ctx: commands.Context): """Starts a persistent view.""" # In order for a persistent view to be listened to, it needs to be sent to an actual message. # Call this method once just to store it somewhere. # In a more complicated program you might fetch the message_id from a database for use later. # However this is outside of the scope of this simple example. await ctx.send("What's your favourite colour?", view=PersistentView()) @bot.command() async def dynamic_button(ctx: commands.Context): """Starts a dynamic button.""" view = discord.ui.View(timeout=None) view.add_item(DynamicButton(ctx.author.id)) await ctx.send('Here is your very own button!', view=view) bot.run('token')