core

Documentation

Index

• func IsPipingError(err error) bool
• func RunCommand(loadedModules []Module, command Command, commandPrefix string) ([]string, error)
• type Base
  • func NewBase(moduleName string, sender Sender, conf config.Config) Base
  • func (b *Base) AddCommand(name string, moduleCommand ModuleCommand)
  • func (b *Base) GetCommandArguments(msg string) ([]string, error)
  • func (b *Base) GetCommandName(msg string) (string, error)
  • func (b *Base) HandleEvent(event *irc.Event)
  • func (b *Base) RunCommand(command Command) ([]string, error)
• type Command
• type CommandArguments
• type Module
• type ModuleCommand
• type Sender
  • func NewSender(conn *irc.Connection) Sender

Functions

func IsPipingError

func IsPipingError(err error) bool

func RunCommand

func RunCommand(loadedModules []Module, command Command, commandPrefix string) ([]string, error)

Types

type Base

type Base struct {
	Config config.Config
	Sender Sender

	Log logging.Logger
	// contains filtered or unexported fields
}

func NewBase

func NewBase(moduleName string, sender Sender, conf config.Config) Base

func (*Base) AddCommand

func (b *Base) AddCommand(name string, moduleCommand ModuleCommand)

func (*Base) GetCommandArguments

func (b *Base) GetCommandArguments(msg string) ([]string, error)

func (*Base) GetCommandName

func (b *Base) GetCommandName(msg string) (string, error)

func (*Base) HandleEvent

func (b *Base) HandleEvent(event *irc.Event)

func (*Base) RunCommand

func (b *Base) RunCommand(command Command) ([]string, error)

type Command

type Command struct {

	// Text of the command for example ".command argument1 argument2".
	Text string

	// Nick of the person that sent this command for example "nick".
	Nick string

	// Target of the message. A channel name or a nick if the bot is
	// messaged directly. Example: "#channel" or "bot_nick".
	Target string
}

type CommandArguments

type CommandArguments struct {
	Arguments []string
	Nick      string
	Target    string
}

type Module

type Module interface {
	HandleEvent(event *irc.Event)

	RunCommand(command Command) ([]string, error)
}

type ModuleCommand

type ModuleCommand func(arguments CommandArguments) ([]string, error)

type Sender

type Sender interface {
	Reply(e *irc.Event, text string)
	Message(target string, text string)
}

func NewSender

func NewSender(conn *irc.Connection) Sender