plugins

Documentation

Index

• Variables
• type Base
  • func (b *Base) Description() string
  • func (b *Base) Disable() error
  • func (b *Base) Enable() error
  • func (b *Base) Enabled() bool
  • func (b *Base) Name() string
  • func (b *Base) ProcessMessage(s *discordgo.Session, m *discordgo.Message) error
  • func (b *Base) ProcessReactionAdd(s *discordgo.Session, r *discordgo.MessageReactionAdd) error
  • func (b *Base) ProcessReactionRemove(s *discordgo.Session, r *discordgo.MessageReactionRemove) error
  • func (b *Base) RefreshStores(c *firestore.DocumentRef)
  • func (b *Base) SyncStores(c *firestore.DocumentRef)
• type Plugin

Variables

var (
	ErrCannotDisable        = errors.New("cannot disable plugins")
	ErrCannotEnable         = errors.New("cannot enable plugins")
	ErrCannotProcessMessage = errors.New("cannot process message")
	CannotDisable           = func() error {
		return ErrCannotDisable
	}
	CannotEnable = func() error {
		return ErrCannotEnable
	}
)

Types

type Base

type Base struct {
	BaseName        string
	BaseDescription string
	// contains filtered or unexported fields
}

func (*Base) Description

func (b *Base) Description() string

func (*Base) Disable

func (b *Base) Disable() error

func (*Base) Enable

func (b *Base) Enable() error

func (*Base) Enabled

func (b *Base) Enabled() bool

func (*Base) Name

func (b *Base) Name() string

func (*Base) ProcessMessage

func (b *Base) ProcessMessage(s *discordgo.Session, m *discordgo.Message) error

func (*Base) ProcessReactionAdd

func (b *Base) ProcessReactionAdd(s *discordgo.Session, r *discordgo.MessageReactionAdd) error

func (*Base) ProcessReactionRemove

func (b *Base) ProcessReactionRemove(s *discordgo.Session, r *discordgo.MessageReactionRemove) error

func (*Base) RefreshStores

func (b *Base) RefreshStores(c *firestore.DocumentRef)

func (*Base) SyncStores

func (b *Base) SyncStores(c *firestore.DocumentRef)

type Plugin

type Plugin interface {
	Name() string
	Description() string
	Enable() error
	Disable() error
	Enabled() bool
	ProcessMessage(s *discordgo.Session, m *discordgo.Message) error
	ProcessReactionAdd(s *discordgo.Session, r *discordgo.MessageReactionAdd) error
	ProcessReactionRemove(s *discordgo.Session, r *discordgo.MessageReactionRemove) error
	SyncStores(c *firestore.DocumentRef)
	RefreshStores(c *firestore.DocumentRef)
}