list

Documentation

Index

• Constants
• type Executor
  • func NewExecutor(featureRegistry *feature.Registry, commandMap stringmap.StringMap, ...) *Executor
  • func (e *Executor) Execute(s api.DiscordSession, channel model.Snowflake, command *model.Command)
  • func (e *Executor) GetType() int
  • func (e *Executor) PublicOnly() bool
• type Feature
  • func NewFeature(featureRegistry *feature.Registry, commandMap stringmap.StringMap, ...) *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 NewParser() *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 (
	// MsgGistAddress is a user-visible string announcing the url of the gist
	MsgGistAddress = "The list of commands is here"
	// MsgListBuiltins is a user-visible header for the list of builtins
	MsgListBuiltins = "List of builtins:"
	// MsgListCustom is a user-visible header for the list of learned commands
	MsgListCustom = "List of learned commands:"
)

const (
	// MsgHelpList is the help text for ?list
	MsgHelpList = "Type `?list` to get the URL of a Gist with all builtin and learned commands"
)

Types

type Executor

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

Executor uploads all command keys to hastebin and returns the url to the user

func NewExecutor

func NewExecutor(featureRegistry *feature.Registry, commandMap stringmap.StringMap, gist api.Gist) *Executor

NewExecutor works as advertised

func (*Executor) Execute

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

Execute uploads the command list to github and pings the gist link in chat.

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 lists commands that are available.

func NewFeature

func NewFeature(
	featureRegistry *feature.Registry,
	commandMap stringmap.StringMap,
	gist api.Gist) *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 returns the list 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 ?list commands.

func NewParser

func NewParser() *Parser

NewParser 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 list command.