action

Documentation

Overview

Package action holds common bot actions that can be called via multiple sources.

Index

• Variables
• type Announcement
  • func (a *Announcement) Empty() bool
  • func (a *Announcement) Update(connection *db.Connection)
• type Announcements
  • func (a *Announcements) Count() int
  • func (a *Announcements) Current() *Announcements
  • func (a *Announcements) Load(connection *db.Connection)
  • func (a *Announcements) Next() *Announcement
• type Announcer
  • func (a *Announcer) Run()
• type Audit
  • func (a *Audit) Definition() *command.Definition
  • func (a *Audit) Handle(event command.Event) error
• type Base
  • func (b *Base) Random(table string, result interface{}) (int, error)
• type Joke
  • func (j *Joke) Definition() *command.Definition
  • func (j *Joke) Get(s *discordgo.Session) *discordgo.MessageEmbed
  • func (j *Joke) Handle(event command.Event) error
  • func (j *Joke) Handler(s *discordgo.Session, in *discordgo.Message)
• type Menu
  • func (m *Menu) Definition() *command.Definition
  • func (m *Menu) Get(user string) string
  • func (m *Menu) Handle(event command.Event) error
  • func (m *Menu) Handler(s *discordgo.Session, in *discordgo.Message)
• type Named
• type Preview
  • func (p *Preview) Definition() *command.Definition
  • func (p *Preview) Get(id int) Announcement
  • func (p *Preview) Handle(event command.Event) error
• type Vend
  • func (m *Vend) Definition() *command.Definition
  • func (m *Vend) Get(user string) string
  • func (m *Vend) Handle(event command.Event) error
  • func (m *Vend) Handler(s *discordgo.Session, in *discordgo.Message)

Variables

var ErrTableEmpty = errors.New("table is empty")

ErrTableEmpty is returned if a Random call is made on an empty table.

Types

type Announcement

type Announcement struct {
	ID      int       `json:"id"`
	Author  string    `json:"author"`
	Message string    `json:"message"`
	Start   time.Time `json:"start"`
	End     time.Time `json:"end"`
	Last    time.Time `json:"last"`
}

Announcement to make.

func (*Announcement) Empty

func (a *Announcement) Empty() bool

Empty returns true if an Announcement is empty.

func (*Announcement) Update

func (a *Announcement) Update(connection *db.Connection)

Update the last time the Announcement was made.

type Announcements

type Announcements []*Announcement

Announcements to make.

func (*Announcements) Count

func (a *Announcements) Count() int

Count of announcements.

func (*Announcements) Current

func (a *Announcements) Current() *Announcements

Current announcements, that is announcements that have a start time before now and an end time after now.

func (*Announcements) Load

func (a *Announcements) Load(connection *db.Connection)

Load the announcements.

func (*Announcements) Next

func (a *Announcements) Next() *Announcement

Next announcement to make. This is determined by least recently announced item. If neither item has been announced then the item with the earliest start time is next.

type Announcer

type Announcer struct {
	Refresh bool      `json:"refresh"`
	Bot     string    `json:"bot"`
	Channel string    `json:"channel"`
	Last    time.Time `json:"last"`
	Next    time.Time `json:"next"`

	Authors    *embed.Authors     `json:"-"`
	Session    *discordgo.Session `json:"-"`
	Connection *db.Connection     `json:"-"`
	// contains filtered or unexported fields
}

Announcer used to display Announcements.

func (*Announcer) Run

func (a *Announcer) Run()

Run the Announcer.

type Audit

type Audit struct {
	Base
}

Audit action.

func (*Audit) Definition

func (a *Audit) Definition() *command.Definition

Definition for the audit command.

func (*Audit) Handle

func (a *Audit) Handle(event command.Event) error

Handle the audit command.

type Base

type Base struct {
	Command     string
	Description string

	Connection *db.Connection
}

Base action.

func (*Base) Random

func (b *Base) Random(table string, result interface{}) (int, error)

Random item from a table with a numeric id column.

type Joke

type Joke struct {
	Base
}

Joke action.

func (*Joke) Definition

func (j *Joke) Definition() *command.Definition

Definition for the joke command.

func (*Joke) Get

func (j *Joke) Get(s *discordgo.Session) *discordgo.MessageEmbed

Get a joke as a MessageEmbed.

func (*Joke) Handle

func (j *Joke) Handle(event command.Event) error

Handle the joke command.

func (*Joke) Handler

func (j *Joke) Handler(s *discordgo.Session, in *discordgo.Message)

Handler listens for the joke command.

type Menu

type Menu struct {
	Base
}

Menu action.

func (*Menu) Definition

func (m *Menu) Definition() *command.Definition

Definition for the room service command.

func (*Menu) Get

func (m *Menu) Get(user string) string

Get item from the menu for the given user.

func (*Menu) Handle

func (m *Menu) Handle(event command.Event) error

Handle the room-service command.

func (*Menu) Handler

func (m *Menu) Handler(s *discordgo.Session, in *discordgo.Message)

Handler listens for the menu command.

type Named

type Named interface {
	Names() []string
}

Named data which can have its named returned.

type Preview

type Preview struct {
	Base
	Authors *embed.Authors
}

Preview commands.

func (*Preview) Definition

func (p *Preview) Definition() *command.Definition

Definition for the room preview command.

func (*Preview) Get

func (p *Preview) Get(id int) Announcement

Get the given announcement.

func (*Preview) Handle

func (p *Preview) Handle(event command.Event) error

Handle the room-service command.

type Vend

type Vend struct {
	Base
}

Vend action.

func (*Vend) Definition

func (m *Vend) Definition() *command.Definition

Definition for the room service command.

func (*Vend) Get

func (m *Vend) Get(user string) string

Get item from the vending machine for the given user.

func (*Vend) Handle

func (m *Vend) Handle(event command.Event) error

Handle the room-service command.

func (*Vend) Handler

func (m *Vend) Handler(s *discordgo.Session, in *discordgo.Message)

Handler listens for the vend command.