bot

Documentation

Overview

Package bot provides a basic embeddable Bot struct for more easily handling commands

Index

• type Bot
  • func New(token string) (*Bot, error)
  • func NewWithRouter(r *bcr.Router) *Bot
  • func (bot *Bot) Add(f func(*Bot) (string, []*bcr.Command))
  • func (bot *Bot) CommandList(ctx *bcr.Context) (err error)
  • func (bot *Bot) Owner(owners ...discord.UserID)
  • func (bot *Bot) Prefix(prefixes ...string)
  • func (bot *Bot) Start() error
  • func (bot *Bot) UpdateStatus(name string, s gateway.Status) (err error)
• type Module

Types

type Bot

type Bot struct {
	Router *bcr.Router

	Modules []Module
}

Bot is the main bot struct

func New

func New(token string) (*Bot, error)

New creates a new instance of Bot. The token will be prefixed with `Bot ` automatically.

func NewWithRouter

func NewWithRouter(r *bcr.Router) *Bot

NewWithRouter creates a new bot with the given router

func (*Bot) Add

func (bot *Bot) Add(f func(*Bot) (string, []*bcr.Command))

Add adds a module to the bot

func (*Bot) CommandList

func (bot *Bot) CommandList(ctx *bcr.Context) (err error)

CommandList is a command that shows a list of all commands in the bot instance

func (*Bot) Owner

func (bot *Bot) Owner(owners ...discord.UserID)

Owner is a helper function to set the bot's owner(s)

func (*Bot) Prefix

func (bot *Bot) Prefix(prefixes ...string)

Prefix is a helper function to set the bot's router's prefixes

func (*Bot) Start

func (bot *Bot) Start() error

Start wraps around Router.State.Open()

func (*Bot) UpdateStatus

func (bot *Bot) UpdateStatus(name string, s gateway.Status) (err error)

UpdateStatus sets the bot's status to the given string

type Module

type Module interface {
	String() string
	Commands() []*bcr.Command
}

Module is a single module/category of commands