action

Documentation

Overview

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

Index

• func Jitter(d, jitter time.Duration) time.Duration
• type Activities
  • func (a Activities) Current() Activities
  • func (a Activities) Len() int
  • func (a Activities) Less(i, j int) bool
  • func (a Activities) Swap(i, j int)
• type Activity
  • func (a *Activity) Before(b *Activity) bool
  • func (a *Activity) Ongoing() bool
• type Amenity
  • func NewAmenities(object store.Object, authors *embed.Authors, messenger message.Messenger) *Amenity
  • func (a *Amenity) Publish()
• type Joke
  • func NewJoke(store store.Object) *Joke
  • func (j *Joke) Random(s *discordgo.Session) *discordgo.MessageEmbed
  • func (j *Joke) Refresh() error
• type Jokes
• type Menu
  • func NewMenu(store store.Object) *Menu
  • func (m *Menu) Random(user string) string
  • func (m *Menu) Refresh() error

Functions

func Jitter

func Jitter(d, jitter time.Duration) time.Duration

Jitter adds some jitter to a duration

Types

type Activities

type Activities []*Activity

Activities we want to publicise.

func (Activities) Current

func (a Activities) Current() Activities

Current set of running Activities.

func (Activities) Len

func (a Activities) Len() int

func (Activities) Less

func (a Activities) Less(i, j int) bool

func (Activities) Swap

func (a Activities) Swap(i, j int)

type Activity

type Activity struct {
	Start     time.Time `json:"start"`
	End       time.Time `json:"end"`
	Announced time.Time `json:"-"`

	Announcement embed.Definition
}

Activity that we want to publicise.

func (*Activity) Before

func (a *Activity) Before(b *Activity) bool

Before returns true if this activity happens before the given one.

func (*Activity) Ongoing

func (a *Activity) Ongoing() bool

Ongoing returns true if the Activity is currently running.

type Amenity

type Amenity struct {
	Channel   string
	Authors   *embed.Authors
	Messenger message.Messenger

	Frequency time.Duration
	Jitter    time.Duration

	store.Data
	Activities
}

Amenity activities.

func NewAmenities

func NewAmenities(object store.Object, authors *embed.Authors, messenger message.Messenger) *Amenity

NewAmenities returns a new Amenity action.

func (*Amenity) Publish

func (a *Amenity) Publish()

Publish Amenities announcements as required.

type Joke

type Joke struct {
	Store store.Object
	Jokes
}

Joke action.

func NewJoke

func NewJoke(store store.Object) *Joke

NewJoke returns a new Joke Action.

func (*Joke) Random

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

Random joke as a MessageEmbed.

func (*Joke) Refresh

func (j *Joke) Refresh() error

Refresh the joke set from the joke store.

type Jokes

type Jokes []struct {
	Author string
	Joke   string
}

Jokes defines the stored data.

type Menu

type Menu struct {
	Store store.Object
	Items []string
}

Menu action.

func NewMenu

func NewMenu(store store.Object) *Menu

NewMenu returns a new Menu action.

func (*Menu) Random

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

Random menu item.

func (*Menu) Refresh

func (m *Menu) Refresh() error

Refresh the menu set from the menu store.