BaseMenu

class dpymenus.BaseMenu(ctx)

The abstract base menu object. All menu types derive from this class. Implements generic properties, menu loop handling, and defines various helper methods.

set_timeout(duration)

Sets the timeout on a menu. Returns itself for fluent-style chaining.

Parameters

duration (int) – Specifies how long, in seconds, before the menu will time out.

Return type

BaseMenu

set_destination(dest)

Sets the message destination for the menu. Returns itself for fluent-style chaining.

Parameters

dest (Union[User, TextChannel]) – Where, in Discord, to send and display the menu.

Return type

BaseMenu

disable_replies()

Disables the Reply feature on Discord from being used with this menu. Overrides the global settings. Returns itself for fluent-style chaining.

Return type

BaseMenu

show_command_message()

Persists user command invocation messages in the chat instead of deleting them after execution. Returns itself for fluent-style chaining.

Return type

BaseMenu

persist_on_close()

Prevents message cleanup from running when a menu closes. Returns itself for fluent-style chaining.

Return type

BaseMenu

set_custom_check(fn)

Overrides the default check method for user responses. Returns itself for fluent-style chaining.

Parameters

fn (Callable) – A reference to a predicate function.

Return type

BaseMenu

set_initial_page(index)

Sets the initial page of the menu when opened based on a pages index in the add_pages list. Defaults to 0.

Parameters

index (int) – Which page index to start on.

Return type

BaseMenu

add_hook(when, event, callback)

Sets various callback attributes on the menu so users can hook into specific events. See https://dpymenus.com/lifecycle for the full list of events and hook structure.

Parameters

• when (HookWhen) – Defines which point in the menu lifetime the callback will be executed.

• event (HookEvent) – Defines which event in the menu lifetime the callback will be executed on.

• callback (Callable) – References a function or method which will be executed based on the when and event params.

Return type

BaseMenu

async close()

Gracefully exits out of the menu, performing necessary cleanup of sessions, reactions, and messages.

async next()

Transitions to the next page.

async previous()

Transitions to the previous page.

async to_first()

Transitions to the first page.

async to_last()

Transitions to the last page.

async go_to(page=None)

Transitions to a specific page.

Parameters

page (Union[str, int, None]) – The name of the on_next function for a particular page or its page number. If this is not set, the next page in the list will be called.

last_visited_page()

Returns the last visited page index.

Return type

int

add_pages(pages, template=None)

Adds a list of pages to a menu, setting their index based on the position in the list. Returns itself for fluent-style chaining.

Parameters

• pages (List[ForwardRef]) – A list of pages to display; ordered from first to last in linear menus.

• template (Template) – An optional Template to define a menu style.

Return type

BaseMenu

async send_message(page)

Updates the output message if it can be edited, otherwise sends a new message.

Parameters

page (PageType) – A PageType to send to Discord.