bcr

package module

Go to main page

Versions in this module

v0

v0.21.0

Sep 19, 2021

Changes in this version

type Context

+ func (ctx *Context) SendComponents(components []discord.Component, content string, embeds ...discord.Embed) (*discord.Message, error)

type Contexter

+ ConfirmButton func(userID discord.UserID, data ConfirmData) (yes, timeout bool)

+ SendComponents func([]discord.Component, string, ...discord.Embed) (*discord.Message, error)

+ type Group struct

+ Description string

+ Name string

+ Subcommands []*Command

+ func (g *Group) Add(cmd *Command) *Group

+ func (g Group) Command() discord.Command

type Router

+ func (r *Router) AddGroup(g *Group)

type SlashContext

+ AdditionalParams map[string]interface{}

+ func (ctx *SlashContext) ConfirmButton(userID discord.UserID, data ConfirmData) (yes, timeout bool)

+ func (ctx *SlashContext) SendComponents(components []discord.Component, content string, embeds ...discord.Embed) (*discord.Message, error)

v0.20.0

Aug 10, 2021

Changes in this version

+ var ErrNotCommand = errors.New("not a command interaction")

type Command

+ Options *[]discord.CommandOption

+ SlashCommand func(Contexter) error

type Context

+ FlagMap map[string]interface{}

+ ParentChannel *discord.Channel

+ func (ctx *Context) AddReactionHandlerRemove(msg discord.MessageID, user discord.UserID, reaction string, ...)

+ func (ctx *Context) AddReactionHandlerWithTimeoutRemove(msg discord.MessageID, user discord.UserID, reaction string, ...)

+ func (ctx *Context) ButtonPagesWithComponents(embeds []discord.Embed, timeout time.Duration, components []discord.Component) (msg *discord.Message, rmFunc func(), err error)

+ func (ctx *Context) EditOriginal(data api.EditInteractionResponseData) (*discord.Message, error)

+ func (ctx *Context) GetBoolFlag(name string) bool

+ func (ctx *Context) GetChannel() *discord.Channel

+ func (ctx *Context) GetChannelFlag(name string) (*discord.Channel, error)

+ func (ctx *Context) GetFloatFlag(name string) float64

+ func (ctx *Context) GetGuild() *discord.Guild

+ func (ctx *Context) GetIntFlag(name string) int64

+ func (ctx *Context) GetMember() *discord.Member

+ func (ctx *Context) GetMemberFlag(name string) (*discord.Member, error)

+ func (ctx *Context) GetParentChannel() *discord.Channel

+ func (ctx *Context) GetRoleFlag(name string) (*discord.Role, error)

+ func (ctx *Context) GetStringFlag(name string) string

+ func (ctx *Context) GetUserFlag(name string) (*discord.User, error)

+ func (ctx *Context) SendEphemeral(content string, embeds ...discord.Embed) (err error)

+ func (ctx *Context) SendFiles(content string, files ...sendpart.File) (err error)

+ func (ctx *Context) SendX(content string, embeds ...discord.Embed) (err error)

+ func (ctx *Context) SendfX(format string, args ...interface{}) (err error)

+ func (ctx *Context) Thread() bool

+ func (ctx *Context) User() discord.User

+ type Contexter interface

+ ButtonPages func(embeds []discord.Embed, timeout time.Duration) (msg *discord.Message, rmFunc func(), err error)

+ ButtonPagesWithComponents func(embeds []discord.Embed, timeout time.Duration, components []discord.Component) (msg *discord.Message, rmFunc func(), err error)

+ EditOriginal func(api.EditInteractionResponseData) (*discord.Message, error)

+ GetChannel func() *discord.Channel

+ GetGuild func() *discord.Guild

+ GetMember func() *discord.Member

+ GetParentChannel func() *discord.Channel

+ Send func(string, ...discord.Embed) (*discord.Message, error)

+ SendEphemeral func(string, ...discord.Embed) error

+ SendFiles func(string, ...sendpart.File) error

+ SendX func(string, ...discord.Embed) error

+ Sendf func(string, ...interface{}) (*discord.Message, error)

+ SendfX func(string, ...interface{}) error

+ Session func() *state.State

+ User func() discord.User

+ type Flags interface

+ GetBoolFlag func(name string) bool

+ GetChannelFlag func(name string) (*discord.Channel, error)

+ GetFloatFlag func(name string) float64

+ GetIntFlag func(name string) int64

+ GetMemberFlag func(name string) (*discord.Member, error)

+ GetRoleFlag func(name string) (*discord.Role, error)

+ GetStringFlag func(name string) string

+ GetUserFlag func(name string) (*discord.User, error)

type Router

+ func (r *Router) ExecuteSlash(ctx *SlashContext) (err error)

+ func (r *Router) InteractionCreate(ic *gateway.InteractionCreateEvent)

+ func (r *Router) NewSlashContext(ic *gateway.InteractionCreateEvent) (*SlashContext, error)

+ func (r *Router) ReactionRemove(ev *gateway.MessageReactionRemoveEvent)

+ func (r *Router) SyncCommands(guildIDs ...discord.GuildID) (err error)

+ type SlashCommandOption struct

+ func (o SlashCommandOption) Bool() bool

+ func (o SlashCommandOption) Channel() (*discord.Channel, error)

+ func (o SlashCommandOption) Float() float64

+ func (o SlashCommandOption) Int() int64

+ func (o SlashCommandOption) Member() (*discord.Member, error)

+ func (o SlashCommandOption) Option(name string) SlashCommandOption

+ func (o SlashCommandOption) Role() (*discord.Role, error)

+ func (o SlashCommandOption) User() (*discord.User, error)

+ type SlashCommandOptions struct

+ func NewSlashCommandOptions(ctx *SlashContext, s []gateway.InteractionOption) SlashCommandOptions

+ func (options SlashCommandOptions) Get(name string) SlashCommandOption

+ type SlashContext struct

+ Author discord.User

+ Channel *discord.Channel

+ Command *Command

+ CommandID discord.CommandID

+ CommandName string

+ CommandOptions []gateway.InteractionOption

+ Event *gateway.InteractionCreateEvent

+ Guild *discord.Guild

+ InteractionID discord.InteractionID

+ InteractionToken string

+ Member *discord.Member

+ ParentChannel *discord.Channel

+ Router *Router

+ State *state.State

+ func (ctx *SlashContext) AddButtonHandler(msg discord.MessageID, user discord.UserID, customID string, del bool, ...) ButtonRemoveFunc

+ func (ctx *SlashContext) ButtonPages(embeds []discord.Embed, timeout time.Duration) (msg *discord.Message, rmFunc func(), err error)

+ func (ctx *SlashContext) ButtonPagesWithComponents(embeds []discord.Embed, timeout time.Duration, components []discord.Component) (msg *discord.Message, rmFunc func(), err error)

+ func (ctx *SlashContext) EditOriginal(data api.EditInteractionResponseData) (*discord.Message, error)

+ func (ctx *SlashContext) GetBoolFlag(name string) bool

+ func (ctx *SlashContext) GetChannel() *discord.Channel

+ func (ctx *SlashContext) GetChannelFlag(name string) (*discord.Channel, error)

+ func (ctx *SlashContext) GetFloatFlag(name string) float64

+ func (ctx *SlashContext) GetGuild() *discord.Guild

+ func (ctx *SlashContext) GetIntFlag(name string) int64

+ func (ctx *SlashContext) GetMember() *discord.Member

+ func (ctx *SlashContext) GetMemberFlag(name string) (*discord.Member, error)

+ func (ctx *SlashContext) GetParentChannel() *discord.Channel

+ func (ctx *SlashContext) GetRoleFlag(name string) (*discord.Role, error)

+ func (ctx *SlashContext) GetStringFlag(name string) string

+ func (ctx *SlashContext) GetUserFlag(name string) (*discord.User, error)

+ func (ctx *SlashContext) GuildPerms() (perms discord.Permissions)

+ func (ctx *SlashContext) Option(name string) (option SlashCommandOption)

+ func (ctx *SlashContext) Original() (msg *discord.Message, err error)

+ func (ctx *SlashContext) Send(content string, embeds ...discord.Embed) (msg *discord.Message, err error)

+ func (ctx *SlashContext) SendEphemeral(content string, embeds ...discord.Embed) (err error)

+ func (ctx *SlashContext) SendFiles(content string, files ...sendpart.File) (err error)

+ func (ctx *SlashContext) SendX(content string, embeds ...discord.Embed) (err error)

+ func (ctx *SlashContext) Sendf(tmpl string, args ...interface{}) (msg *discord.Message, err error)

+ func (ctx *SlashContext) SendfX(format string, args ...interface{}) (err error)

+ func (ctx *SlashContext) Session() *state.State

+ func (ctx *SlashContext) Thread() bool

+ func (ctx *SlashContext) User() discord.User

v0.19.1

Jul 11, 2021

Changes in this version

+ type ButtonRemoveFunc func()

type Context

+ func (ctx *Context) AddButtonHandler(msg discord.MessageID, user discord.UserID, customID string, del bool, ...) ButtonRemoveFunc

+ func (ctx *Context) ButtonPages(embeds []discord.Embed, timeout time.Duration) (msg *discord.Message, rmFunc func(), err error)

type Router

+ func (r *Router) ButtonHandler(ev *gateway.InteractionCreateEvent)

v0.19.0

Jul 3, 2021

Changes in this version

+ type ConfirmData struct

+ Embeds []discord.Embed

+ Message string

+ NoPrompt string

+ NoStyle discord.ButtonStyle

+ Timeout time.Duration

+ YesPrompt string

+ YesStyle discord.ButtonStyle

type Context

+ func (ctx *Context) ConfirmButton(userID discord.UserID, data ConfirmData) (yes, timeout bool)

v0.18.0

Jul 1, 2021

Changes in this version

type Command

+ GuildPermissions discord.Permissions

type Context

+ ShardID int

+ func (ctx *Context) GuildPerms() (perms discord.Permissions)

type MessageSend

+ func (m *MessageSend) Embeds(e ...discord.Embed) *MessageSend

type Router

+ ShardManager *shard.Manager

+ func (r *Router) AddHandler(v interface{})

+ func (r *Router) RequireRole(name string, roles ...discord.RoleID) CustomPerms

+ func (r *Router) StateFromGuildID(guildID discord.GuildID) (st *state.State, id int)

v0.17.1

Jun 2, 2021

Changes in this version

+ func StringPaginator(title string, colour discord.Color, slice []string, perPage int) []discord.Embed

type Context

+ func (ctx *Context) CheckBotSendPerms(ch discord.ChannelID, e bool) bool

v0.17.0

Jun 2, 2021

Changes in this version

+ var ErrGuild = errors.New("context: couldn't get guild")

type Context

+ Guild *discord.Guild

+ func (ctx *Context) Replyc(colour discord.Color, template string, args ...interface{}) (m *discord.Message, err error)

v0.16.0

May 25, 2021

Changes in this version

+ const PermissionRequestToSpeak

type Context

+ InternalArgs []string

+ func (ctx *Context) AddReactionHandlerWithTimeout(msg discord.MessageID, user discord.UserID, reaction string, ...)

+ func (ctx *Context) NewLog(title string) *Log

+ func (ctx *Context) PagedEmbedTimeout(embeds []discord.Embed, extendedReactions bool, timeout time.Duration) (msg *discord.Message, timer *time.Timer, err error)

+ func (ctx *Context) SendEmbed(data SendEmbedData) (m *discord.Message, err error)

+ func (ctx *Context) WaitForMessage(ch discord.ChannelID, user discord.UserID, timeout time.Duration, ...) (msg *gateway.MessageCreateEvent, timedOut bool)

+ type Log struct

+ func (log *Log) Error(msg string)

+ func (log *Log) Log(msg string)

+ func (log *Log) Replace(msg string)

+ func (log *Log) Send()

+ func (log *Log) SetColor(color discord.Color)

+ func (log *Log) SetTitle(title string)

+ type SED = SendEmbedData

+ type SendEmbedData struct

+ Color discord.Color

+ Footer string

+ Message string

+ Title string

v0.15.1

Apr 24, 2021

Changes in this version

+ func FieldPaginator(title, description string, colour discord.Color, fields []discord.EmbedField, ...) []discord.Embed

+ type LogFunc func(template string, args ...interface{})

+ type Logger struct

+ Debug LogFunc

+ Error LogFunc

+ Info LogFunc

+ func NewNoopLogger() *Logger

+ func NewStdlibLogger(debug bool) *Logger

+ func NewZapLogger(s *zap.SugaredLogger) *Logger

type Router

+ Logger *Logger

v0.15.0

Apr 7, 2021

Changes in this version

type Command

+ Flags func(fs *pflag.FlagSet) *pflag.FlagSet

type Context

+ Flags *pflag.FlagSet

v0.14.2

Mar 30, 2021

Changes in this version

+ const PermissionViewServerInsights

+ var AllPerms = append(MajorPerms, append(NotablePerms, MinorPerms))

+ var MajorPerms = []Perm

+ var MinorPerms = []Perm

+ var NotablePerms = []Perm

+ type Perm struct

+ Name string

+ Permission discord.Permissions

v0.14.1

Mar 26, 2021

v0.14.0

Mar 26, 2021

Changes in this version

+ const ColourBlue

+ const ColourBlurple

+ const ColourDarkBlue

+ const ColourDarkGold

+ const ColourDarkGreen

+ const ColourDarkGrey

+ const ColourDarkMagenta

+ const ColourDarkOrange

+ const ColourDarkPurple

+ const ColourDarkRed

+ const ColourDarkTeal

+ const ColourDarkTheme

+ const ColourDarkerGrey

+ const ColourGold

+ const ColourGreen

+ const ColourGreyple

+ const ColourLightGrey

+ const ColourLighterGrey

+ const ColourMagenta

+ const ColourOrange

+ const ColourPurple

+ const ColourRed

+ const ColourTeal

+ const PermissionUseSlashCommands

+ var ErrMessageNotFound = errors.New("message not found")

+ var ErrorFailedConversion = errors.New("context: failed conversion in WaitForReaction")

+ var ErrorTimedOut = errors.New("context: timed out waiting for reaction")

+ func HumanizeDuration(precision DurationFormatPrecision, in time.Duration) string

+ func HumanizeTime(precision DurationFormatPrecision, in time.Time) string

+ func PermStringsFor(m map[discord.Permissions]string, p discord.Permissions) []string

type Context

+ State *state.State

+ func (ctx *Context) Confirm(s string) (yes bool)

+ func (ctx *Context) DisplayName() string

+ func (ctx *Context) ParseMessage(s string) (m *discord.Message, err error)

+ func (ctx *Context) WaitForReaction(msg discord.Message, user discord.UserID) (ev *gateway.MessageReactionAddEvent, err error)

+ func (ctx *Context) WaitForReactionWithTimeout(msg discord.Message, user discord.UserID, timeout time.Duration) (ev *gateway.MessageReactionAddEvent, err error)

+ func (ctx *Context) YesNoHandlerWithTimeout(msg discord.Message, user discord.UserID, t time.Duration) (yes, timeout bool)

+ type DurationFormatPrecision int

+ const DurationPrecisionDays

+ const DurationPrecisionHours

+ const DurationPrecisionMinutes

+ const DurationPrecisionSeconds

+ const DurationPrecisionWeeks

+ const DurationPrecisionYears

+ func (d DurationFormatPrecision) FromSeconds(in int64) int64

+ func (d DurationFormatPrecision) String() string

+ type Roles []discord.Role

+ func (r Roles) Len() int

+ func (r Roles) Less(i, j int) bool

+ func (r Roles) Swap(i, j int)

type Router

+ ReactTimeout time.Duration

+ State *state.State

v0.13.0

Mar 9, 2021

Changes in this version

type Context

+ FullCommandPath []string

+ Member *discord.Member

+ Prefix string

v0.12.0

Mar 7, 2021

Changes in this version

type Context

+ func (ctx *Context) YesNoHandler(msg discord.Message, user discord.UserID) (yes, timeout bool)

v0.11.0

Feb 26, 2021

Changes in this version

+ type Prefixer func(m discord.Message) int

type Router

+ Prefixer Prefixer

+ func (r *Router) DefaultPrefixer(m discord.Message) int

v0.10.0

Feb 16, 2021

Changes in this version

type Context

+ func (ctx *Context) Peek() string

+ func (ctx *Context) Pop() string

type Router

+ func New(s *state.State, owners, prefixes []string) *Router

+ func NewWithIntents(token string, owners []discord.UserID, prefixes []string, ...) (*Router, error)

v0.9.1

Feb 9, 2021

Changes in this version

type Context

+ func (ctx *Context) NewDM(user discord.UserID) *MessageSend

type MessageSend

+ func (m *MessageSend) AddFile(name string, reader io.Reader) *MessageSend

v0.9.0

Feb 6, 2021

Changes in this version

type Context

+ func (ctx *Context) NewMessage() *MessageSend

+ type MessageSend struct

+ Data api.SendMessageData

+ func (m *MessageSend) AllowedMentions(a *api.AllowedMentions) *MessageSend

+ func (m *MessageSend) BlockMentions() *MessageSend

+ func (m *MessageSend) Channel(c discord.ChannelID) *MessageSend

+ func (m *MessageSend) Content(c string) *MessageSend

+ func (m *MessageSend) Embed(e *discord.Embed) *MessageSend

+ func (m *MessageSend) Reference(id discord.MessageID) *MessageSend

+ func (m *MessageSend) Send() (msg *discord.Message, err error)

+ func (m *MessageSend) TogglePermCheck() *MessageSend

v0.8.0

Feb 4, 2021

Changes in this version

+ var ErrEmptyMessage = errors.New("context: message was empty")

+ type Args [2]int

+ func ArgRange(i, j int) *Args

+ func ExactArgs(i int) *Args

+ func MaxArgs(i int) *Args

+ func MinArgs(i int) *Args

type Command

+ Args *Args

+ type Commands []*Command

+ func (c Commands) Len() int

+ func (c Commands) Less(i, j int) bool

+ func (c Commands) Swap(i, j int)

v0.7.3

Jan 23, 2021

Changes in this version

+ const RequiredIntents

+ var ErrBotMissingPermissions = errors.New("bot is missing permissions")

+ var ErrChannel = errors.New("context: couldn't get channel")

+ var ErrChannelNotFound = errors.New("channel not found")

+ var ErrInvalidMention = errors.New("invalid mention")

+ var ErrMemberNotFound = errors.New("member not found")

+ var ErrNilCommand = errors.New("alias: command was nil")

+ var ErrNoBotUser = errors.New("context: couldn't get bot user")

+ var ErrNoEmbeds = errors.New("PagedEmbed: no embeds")

+ var ErrNoPath = errors.New("alias: no path supplied")

+ var ErrRoleNotFound = errors.New("role not found")

+ var ErrUserNotFound = errors.New("user not found")

+ var ErrorNotEnoughArgs = errors.New("not enough arguments")

+ var ErrorTooManyArgs = errors.New("too many arguments")

+ func AsCode(s string) string

+ func DefaultValue(s, def string) string

+ func EscapeBackticks(s string) string

+ func HasAnyPrefix(s string, prefixes ...string) bool

+ func HasAnySuffix(s string, suffixes ...string) bool

+ func PermStrings(p discord.Permissions) []string

+ func SprintfAll(template string, in []string) []string

+ func TrimPrefixesSpace(s string, prefixes ...string) string

+ func Version() string

+ type ArgTransformer func(string) string

+ func DefaultArgTransformer(prefix, suffix string) ArgTransformer

+ type Command struct

+ Aliases []string

+ Blacklistable bool

+ Command func(*Context) error

+ Cooldown time.Duration

+ CustomPermissions CustomPerms

+ Description string

+ GuildOnly bool

+ Hidden bool

+ Name string

+ OwnerOnly bool

+ Permissions discord.Permissions

+ Summary string

+ Usage string

+ func (c *Command) AddSubcommand(sub *Command) *Command

+ func (c *Command) GetCommand(name string) *Command

+ type Context struct

+ AdditionalParams map[string]interface{}

+ Args []string

+ Author discord.User

+ Bot *discord.User

+ Channel *discord.Channel

+ Cmd *Command

+ Command string

+ Message discord.Message

+ RawArgs string

+ Router *Router

+ Session *state.State

+ func (ctx *Context) AddMessageHandler(c discord.ChannelID, user discord.UserID, fn func(*Context, discord.Message))

+ func (ctx *Context) AddReactionHandler(msg discord.MessageID, user discord.UserID, reaction string, ...)

+ func (ctx *Context) AddYesNoHandler(msg discord.Message, user discord.UserID, yesFn func(*Context), ...)

+ func (ctx *Context) CheckArgRange(min, max int) (err error)

+ func (ctx *Context) CheckBotPerms(p discord.Permissions) (err error)

+ func (ctx *Context) CheckMinArgs(c int) (err error)

+ func (ctx *Context) CheckPerms() (err error)

+ func (ctx *Context) CheckRequiredArgs(c int) (err error)

+ func (ctx *Context) Edit(m *discord.Message, c string, embed *discord.Embed) (msg *discord.Message, err error)

+ func (ctx *Context) GreedyChannelParser(args []string) (channels []*discord.Channel, n int)

+ func (ctx *Context) GreedyMemberParser(args []string) (members []*discord.Member, n int)

+ func (ctx *Context) GreedyRoleParser(args []string) (roles []*discord.Role, n int)

+ func (ctx *Context) GreedyUserParser(args []string) (users []*discord.User, n int)

+ func (ctx *Context) Help(path []string) (err error)

+ func (ctx *Context) PagedEmbed(embeds []discord.Embed, extendedReactions bool) (msg *discord.Message, err error)

+ func (ctx *Context) ParseChannel(s string) (c *discord.Channel, err error)

+ func (ctx *Context) ParseMember(s string) (c *discord.Member, err error)

+ func (ctx *Context) ParseRole(s string) (c *discord.Role, err error)

+ func (ctx *Context) ParseUser(s string) (u *discord.User, err error)

+ func (ctx *Context) Reply(content string, embed *discord.Embed) (m *discord.Message, err error)

+ func (ctx *Context) Send(content string, embed *discord.Embed) (m *discord.Message, err error)

+ func (ctx *Context) Sendf(template string, args ...interface{}) (m *discord.Message, err error)

+ type CooldownCache struct

+ func (c *CooldownCache) Get(cmdName string, userID discord.UserID, channelID discord.ChannelID) bool

+ func (c *CooldownCache) Set(cmdName string, userID discord.UserID, channelID discord.ChannelID, ...)

+ type CustomPerms interface

+ Check func(*Context) (bool, error)

+ String func() string

+ type PermError struct

+ func (p *PermError) Error() string

+ type Router struct

+ BlacklistFunc func(*Context) bool

+ Bot *discord.User

+ BotOwners []string

+ DefaultMentions *api.AllowedMentions

+ EmbedColor discord.Color

+ HelpCommand func(*Context) error

+ Prefixes []string

+ Session *state.State

+ func NewRouter(s *state.State, owners, prefixes []string) *Router

+ func NewWithState(token string, owners, prefixes []string) (*Router, error)

+ func (r *Router) AddCommand(c *Command) *Command

+ func (r *Router) Alias(name string, path []string, argTransform ArgTransformer) (*Command, error)

+ func (r *Router) AliasMust(name string, path []string, argTransform ArgTransformer) *Command

+ func (r *Router) Commands() []*Command

+ func (r *Router) DeleteReactions(m discord.MessageID)

+ func (r *Router) Execute(ctx *Context) (err error)

+ func (r *Router) GetCommand(name string) *Command

+ func (r *Router) MatchPrefix(content string) bool

+ func (r *Router) MessageCreate(m *gateway.MessageCreateEvent)

+ func (r *Router) MsgHandlerCreate(e *gateway.MessageCreateEvent)

+ func (r *Router) NewContext(m discord.Message) (ctx *Context, err error)

+ func (r *Router) ReactionAdd(e *gateway.MessageReactionAddEvent)

+ func (r *Router) ReactionMessageDelete(m *gateway.MessageDeleteEvent)

+ func (r *Router) SetBotUser() error

Other modules containing this package

github.com/starshine-sys/bcr/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL