command

Documentation

Index

• func DefaultCall(c *Command, ctx *context.Context) (string, error)
• func DefaultHelp(c *Command, ctx *context.Context) (string, error)
• func DefaultUnload(c *Command) error
• type AllowedChatType
• type Command
  • func New(b *bot.Bot, name string, commands *map[string]*Command) *Command
  • func NewSubcommand(b *bot.Bot, name string, commands *map[string]*Command, parent *Command) *Command
  • func (c *Command) Build()
  • func (c *Command) Call(ctx *context.Context) (string, error)
  • func (c *Command) Help(ctx *context.Context) (string, error)
  • func (c *Command) Unload() error

Functions

func DefaultCall

func DefaultCall(c *Command, ctx *context.Context) (string, error)

func DefaultHelp

func DefaultHelp(c *Command, ctx *context.Context) (string, error)

func DefaultUnload

func DefaultUnload(c *Command) error

Types

type AllowedChatType

type AllowedChatType int

const (
	AllowedChatTypeAll AllowedChatType = iota
	AllowedChatTypeGuildOnly
	AllowedChatTypeDMOnly
)

type Command

type Command struct {
	UsageDoc string
	ShortDoc string
	LongDoc  string

	Name     string
	Aliases  []string
	Category string // *Category ?
	// bot_perms  []*Permission
	// user_perms []*Permission
	MinArgs int
	// flags      []*FlagOptions
	AllowedChatType AllowedChatType
	Nsfw            bool
	Hidden          bool
	Disabled        bool
	// events     ???
	IsSubCommand bool

	CallFunc   func(*Command, *context.Context) (string, error)
	HelpFunc   func(*Command, *context.Context) (string, error)
	UnloadFUnc func(*Command) error

	Bot        *bot.Bot
	CommandMap *map[string]*Command // TODO: pointer to habdler
	// contains filtered or unexported fields
}

Command represents bot command

func New

func New(b *bot.Bot, name string, commands *map[string]*Command) *Command

Returns new command with most important fields filled

func NewSubcommand

func NewSubcommand(b *bot.Bot, name string, commands *map[string]*Command, parent *Command) *Command

Returns new subcommand with most important fields filled

func (*Command) Build

func (c *Command) Build()

Builds command

func (*Command) Call

func (c *Command) Call(ctx *context.Context) (string, error)

func (*Command) Help

func (c *Command) Help(ctx *context.Context) (string, error)

func (*Command) Unload

func (c *Command) Unload() error