factsphere

Documentation

Index

• Constants
• type Executor
  • func NewFactSphereExecutor() *Executor
  • func (e *Executor) Execute(s api.DiscordSession, channelID model.Snowflake, command *model.Command)
  • func (e *Executor) GetType() int
  • func (e *Executor) PublicOnly() bool
• type Feature
  • func NewFeature(featureRegistry *feature.Registry) *Feature
  • func (f *Feature) CommandInterceptors() []feature.CommandInterceptor
  • func (f *Feature) Executors() []feature.Executor
  • func (f *Feature) FallbackParser() feature.Parser
  • func (f *Feature) OnInitialLoad(s api.DiscordSession) error
  • func (f *Feature) Parsers() []feature.Parser
• type Parser
  • func NewFactSphereParser() *Parser
  • func (p *Parser) GetName() string
  • func (p *Parser) HelpText(command string) (string, error)
  • func (p *Parser) Parse(splitContent []string, m *discordgo.MessageCreate) (*model.Command, error)

Constants

const (
	// MsgHelpFactSphere is the help text for ?factsphere.
	MsgHelpFactSphere = "Type `?factsphere` to get a random fact, which may or may not be true."
)

Types

type Executor

type Executor struct {
}

Executor prints a random ?factsphere command for the user.

func NewFactSphereExecutor

func NewFactSphereExecutor() *Executor

NewFactSphereExecutor works as advertised.

func (*Executor) Execute

func (e *Executor) Execute(s api.DiscordSession, channelID model.Snowflake, command *model.Command)

Execute returns a random factsphere fact

func (*Executor) GetType

func (e *Executor) GetType() int

GetType returns the type of this feature.

func (*Executor) PublicOnly

func (e *Executor) PublicOnly() bool

PublicOnly returns whether the executor should be intercepted in a private channel.

type Feature

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

Feature is a Feature that prints a random fact to the user.

func NewFeature

func NewFeature(featureRegistry *feature.Registry) *Feature

NewFeature returns a new Feature.

func (*Feature) CommandInterceptors

func (f *Feature) CommandInterceptors() []feature.CommandInterceptor

CommandInterceptors returns nothing.

func (*Feature) Executors

func (f *Feature) Executors() []feature.Executor

Executors gets the executors.

func (*Feature) FallbackParser

func (f *Feature) FallbackParser() feature.Parser

FallbackParser returns nil.

func (*Feature) OnInitialLoad

func (f *Feature) OnInitialLoad(s api.DiscordSession) error

OnInitialLoad does nothing.

func (*Feature) Parsers

func (f *Feature) Parsers() []feature.Parser

Parsers returns the parsers.

type Parser

type Parser struct{}

Parser parses ?factsphere commands.

func NewFactSphereParser

func NewFactSphereParser() *Parser

NewFactSphereParser works as advertised.

func (*Parser) GetName

func (p *Parser) GetName() string

GetName returns the named type of this feature.

func (*Parser) HelpText

func (p *Parser) HelpText(command string) (string, error)

HelpText explains how to use ?list.

func (*Parser) Parse

func (p *Parser) Parse(splitContent []string, m *discordgo.MessageCreate) (*model.Command, error)

Parse parses the given factsphere command.