[][src]Module serenity_utils::menu

Reaction-based menu functionality.

It provides three default menu control functions that:

  • move to previous page
  • move to next page
  • close menu

These functions are exposed publicly to allow customisation. Custom control functions can also be used with a menu. For more information, see Menu.

Note: This functionality has been ported from Red-DiscordBot's menu function.

Structs

Control

A struct representing a control for reaction menus.

Menu

A fully functioning reaction-based menu.

MenuOptions

Options to tweak a menu.

Functions

close_menu

Closes a reaction menu by deleting the menu's message.

next_page

Moves a reaction menu forward.

prev_page

Moves a reaction menu backward.

Type Definitions

ControlFunction

A function used to control the behaviour of a reaction menu's reaction.

MenuResult

Result variant for menu methods.