commands

Documentation

Index

• type BaseCommand
  • func (c BaseCommand) ACL() (acl.ChannelRestriction, acl.RoleRestriction)
  • func (c BaseCommand) Calls() (string, []string)
  • func (c BaseCommand) DisplayHelp(s *discordgo.Session, m *discordgo.Message, prefix string)
  • func (c BaseCommand) GetHelp() Help
  • func (c BaseCommand) Opts() Options
• type Command
  • func InitializeAllCommands(p *player.Players, l zerolog.Logger, sp *soundcloud.SoundCloudProvider, ...) []Command
  • func NewAddCommand(p *player.Players, log zerolog.Logger, sp *soundcloud.SoundCloudProvider) Command
  • func NewFavCommand(p *player.Players, log zerolog.Logger, storage *storage.StormDB) Command
  • func NewJamCommand(p *player.Players, log zerolog.Logger) Command
  • func NewNextCommand(p *player.Players, log zerolog.Logger, sp *soundcloud.SoundCloudProvider) Command
  • func NewNowPlayingCommand(p *player.Players, log zerolog.Logger) Command
  • func NewPauseCommand(p *player.Players, log zerolog.Logger) Command
  • func NewPlayCommand(p *player.Players, log zerolog.Logger) Command
  • func NewQueueCommand(p *player.Players, log zerolog.Logger) Command
  • func NewRemoveCommand(p *player.Players, log zerolog.Logger) Command
  • func NewSetupCommand(p *player.Players, log zerolog.Logger, storage *storage.StormDB) Command
  • func NewSkipCommand(p *player.Players, log zerolog.Logger) Command
  • func NewStatsCommand(p *player.Players, log zerolog.Logger) Command
  • func NewStopCommand(p *player.Players, log zerolog.Logger) Command
  • func NewVolumeCommand(p *player.Players, log zerolog.Logger) Command
• type Example
• type Help
• type Options
• type SubCommand

Types

type BaseCommand

type BaseCommand struct {
	// Permissions
	ChannelRestriction acl.ChannelRestriction
	RoleRestriction    acl.RoleRestriction

	// Command calls
	Long    string
	Aliases []string

	Options Options

	// Internal fields
	SubCommands []SubCommand
	Help        Help
	Players     *player.Players
	// contains filtered or unexported fields
}

func (BaseCommand) ACL

func (c BaseCommand) ACL() (acl.ChannelRestriction, acl.RoleRestriction)

func (BaseCommand) Calls

func (c BaseCommand) Calls() (string, []string)

func (BaseCommand) DisplayHelp

func (c BaseCommand) DisplayHelp(s *discordgo.Session, m *discordgo.Message, prefix string)

func (BaseCommand) GetHelp

func (c BaseCommand) GetHelp() Help

func (BaseCommand) Opts

func (c BaseCommand) Opts() Options

type Command

type Command interface {
	Handler(s *discordgo.Session, m *discordgo.Message, args []string)
	DisplayHelp(s *discordgo.Session, m *discordgo.Message, prefix string)
	GetHelp() Help
	ACL() (acl.ChannelRestriction, acl.RoleRestriction)
	Calls() (string, []string)
	Opts() Options
}

func InitializeAllCommands

func InitializeAllCommands(p *player.Players, l zerolog.Logger, sp *soundcloud.SoundCloudProvider, st *storage.StormDB) []Command

func NewAddCommand

func NewAddCommand(p *player.Players, log zerolog.Logger, sp *soundcloud.SoundCloudProvider) Command

func NewFavCommand

func NewFavCommand(p *player.Players, log zerolog.Logger, storage *storage.StormDB) Command

func NewJamCommand

func NewJamCommand(p *player.Players, log zerolog.Logger) Command

func NewNextCommand

func NewNextCommand(p *player.Players, log zerolog.Logger, sp *soundcloud.SoundCloudProvider) Command

func NewNowPlayingCommand

func NewNowPlayingCommand(p *player.Players, log zerolog.Logger) Command

func NewPauseCommand

func NewPauseCommand(p *player.Players, log zerolog.Logger) Command

func NewPlayCommand

func NewPlayCommand(p *player.Players, log zerolog.Logger) Command

func NewQueueCommand

func NewQueueCommand(p *player.Players, log zerolog.Logger) Command

func NewRemoveCommand

func NewRemoveCommand(p *player.Players, log zerolog.Logger) Command

func NewSetupCommand

func NewSetupCommand(p *player.Players, log zerolog.Logger, storage *storage.StormDB) Command

func NewSkipCommand

func NewSkipCommand(p *player.Players, log zerolog.Logger) Command

func NewStatsCommand

func NewStatsCommand(p *player.Players, log zerolog.Logger) Command

func NewStopCommand

func NewStopCommand(p *player.Players, log zerolog.Logger) Command

func NewVolumeCommand

func NewVolumeCommand(p *player.Players, log zerolog.Logger) Command

type Example

type Example struct {
	Command     string
	Explanation string
}

type Help

type Help struct {
	Examples    []Example
	Usage       string
	Title       string
	ShortDesc   string
	Description string
}

type Options

type Options struct {
	ArgsRequired      bool
	DeleteUserMessage bool
	DMCapability      bool
}

type SubCommand

type SubCommand struct {
	Long        string
	Aliases     []string
	Arg         string
	Description string
}