bot

Documentation

Overview

Package bot handles starting up and running the bot.

Index

• Variables
• func Run(settings config.Settings)
• type Instance
  • func New(id string, connection *db.Connection) (*Instance, error)
  • func (i *Instance) Handler(_ *discordgo.Session, in *discordgo.Message)
  • func (i *Instance) Refresh() error
  • func (i *Instance) Start(session *discordgo.Session)

Variables

var ErrBotNotDefined = errors.New("bot not defined")

ErrBotNotDefined is returned if the bot definition cannot be found in the DB.

Functions

func Run

func Run(settings config.Settings)

Run the bot. nolint: funlen

Types

type Instance

type Instance struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Control string `json:"control"`
	// contains filtered or unexported fields
}

Instance of the bot.

func New

func New(id string, connection *db.Connection) (*Instance, error)

New bot instance.

func (*Instance) Handler

func (i *Instance) Handler(_ *discordgo.Session, in *discordgo.Message)

Handler will listen for a startup message from another bot and shut down if it sees one.

func (*Instance) Refresh

func (i *Instance) Refresh() error

Refresh the instance details from the database.

func (*Instance) Start

func (i *Instance) Start(session *discordgo.Session)

Start the bot. This will attempt to shut down any other bots registered with the same ID and Name.