commands

Documentation

Index

• Variables
• type Command
  • func (cmd *Command) Help() string
  • func (cmd *Command) String() string
• type CommandGroup
  • func NewCommandGroup[User any](namespace string, color game.TextColor) *CommandGroup[User]
  • func (c *CommandGroup[User]) CanHandle(args []string) bool
  • func (c *CommandGroup[User]) GetHelp(args []string) (string, error)
  • func (c *CommandGroup[User]) Handle(ctx context.Context, user User, args []string) error
  • func (c *CommandGroup[User]) Help() string
  • func (c *CommandGroup[User]) Name() string
  • func (c *CommandGroup[User]) Prefix(message string) string
  • func (c *CommandGroup[User]) Register(commands ...Command) error
• type Commandable

Variables

var FALSY = []string{
	"false",
	"no",
	"0",
	"off",
}

var NIL = reflect.ValueOf(nil)

var TRUTHY = []string{
	"true",
	"yes",
	"1",
	"on",
}

Types

type Command

type Command struct {
	Name        string
	Aliases     []string
	ArgFormat   string
	Description string
	Callback    interface{}
}

func (*Command) Help

func (cmd *Command) Help() string

func (*Command) String

func (cmd *Command) String() string

type CommandGroup

type CommandGroup[User any] struct {
	// contains filtered or unexported fields
}

func NewCommandGroup

func NewCommandGroup[User any](namespace string, color game.TextColor) *CommandGroup[User]

func (*CommandGroup[User]) CanHandle

func (c *CommandGroup[User]) CanHandle(args []string) bool

Whether or not this command group can respond to this command.

func (*CommandGroup[User]) GetHelp

func (c *CommandGroup[User]) GetHelp(args []string) (string, error)

func (*CommandGroup[User]) Handle

func (c *CommandGroup[User]) Handle(ctx context.Context, user User, args []string) error

func (*CommandGroup[User]) Help

func (c *CommandGroup[User]) Help() string

func (*CommandGroup[User]) Name

func (c *CommandGroup[User]) Name() string

func (*CommandGroup[User]) Prefix

func (c *CommandGroup[User]) Prefix(message string) string

func (*CommandGroup[User]) Register

func (c *CommandGroup[User]) Register(commands ...Command) error

type Commandable

type Commandable interface {
	// Get help for a specific command (or empty string if it does not exist.)
	GetHelp([]string) (string, error)
	// Lists all commands.
	Help() string
}