core

Documentation

Index

• Constants
• func Tokenize(s string) (tok []string, err error)
• type Registry
  • func NewRegistry(opts ...RegistryOpt) *Registry
  • func (r *Registry) Execute(msg *gb.Message, s gb.Session) error
  • func (r *Registry) Intercept(msg *gb.Message) error
  • func (r *Registry) Parse(dMsg *discordgo.Message) (cmd *gb.Message, err error)
• type RegistryOpt
  • func WithInterceptor(c gb.Command, i gb.Interceptor) RegistryOpt
  • func WithPath(s string) RegistryOpt
  • func WithPrefix(p uint8) RegistryOpt
  • func WithQueue(q *discussion.Queue) RegistryOpt

Constants

const (
	DefaultCommandPrefix = '&'
	DefaultDirPath       = "/store"
)

Functions

func Tokenize

func Tokenize(s string) (tok []string, err error)

Split the message content by spaces while leaving segments in quotes intact Uses regex

Types

type Registry

type Registry struct {
	Interceptors    map[gb.Command]gb.Interceptor // all built-in interceptors
	DirPath         string                        // path to local data
	CommandPrefix   uint8                         // character that precedes all Gobottas commands
	DiscussionQueue *discussion.Queue             // the data structure that holds discussion queue data
}

Contains Gobottas functions and data

func NewRegistry

func NewRegistry(opts ...RegistryOpt) *Registry

func (*Registry) Execute

func (r *Registry) Execute(msg *gb.Message, s gb.Session) error

Calls the Executor to which the Registry points for the Message CommandType

func (*Registry) Intercept

func (r *Registry) Intercept(msg *gb.Message) error

Function to call all Interceptors on a message

func (*Registry) Parse

func (r *Registry) Parse(dMsg *discordgo.Message) (cmd *gb.Message, err error)

Function to parse incoming messages

type RegistryOpt

type RegistryOpt func(*Registry)

func WithInterceptor

func WithInterceptor(c gb.Command, i gb.Interceptor) RegistryOpt

set the interceptor for the given command type; will overwrite any existing interceptor

func WithPath

func WithPath(s string) RegistryOpt

func WithPrefix

func WithPrefix(p uint8) RegistryOpt

func WithQueue

func WithQueue(q *discussion.Queue) RegistryOpt

Opt Functions