wizard

Documentation

Index

• Constants
• type Page
• type Session
  • func New(discord *discordgo.Session, channel, user gophbot.Snowflake, page Page) (*Session, error)
  • func (s *Session) SwitchToPage(page Page) error

Constants

const CloseEmoji = "\U0000274c"

CloseEmoji is the ❌ emoji in Discord, used for the close-wizard button

Types

type Page

type Page interface {
	Embed(*Session) *discordgo.MessageEmbed
	Buttons(*Session) []string
	FireButton(session *Session, emoji string)
}

Page defines what functionality a wizard page should have.

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session is a wizard session, using embeds to display a menu in Discord and reactions for buttons.

func New

func New(discord *discordgo.Session, channel, user gophbot.Snowflake, page Page) (*Session, error)

New creates a new Wizard session.

func (*Session) SwitchToPage

func (s *Session) SwitchToPage(page Page) error

SwitchToPage causes this Session to switch to another page, and replace the buttons.