gommand

package module

Go to main page

Versions in this module

v1

v1.20.0

Dec 30, 2020

Changes in this version

+ type CommandGroup struct

+ Aliases []string

+ Category CategoryInterface

+ Cooldown Cooldown

+ Description string

+ Middleware []Middleware

+ Name string

+ NoCommandSpecified CommandInterface

+ PermissionValidators []PermissionValidator

+ func (g *CommandGroup) AddCommand(cmd CommandInterface)

+ func (g *CommandGroup) CommandFunction(ctx *Context) error

+ func (g *CommandGroup) GetAliases() []string

+ func (g *CommandGroup) GetArgTransformers() []ArgTransformer

+ func (g *CommandGroup) GetCategory() CategoryInterface

+ func (g *CommandGroup) GetCooldown() Cooldown

+ func (g *CommandGroup) GetDescription() string

+ func (g *CommandGroup) GetMiddleware() []Middleware

+ func (g *CommandGroup) GetName() string

+ func (g *CommandGroup) GetPermissionValidators() []PermissionValidator

+ func (g *CommandGroup) GetSubcommands() []CommandInterface

+ func (g *CommandGroup) GetUsage() string

+ func (g *CommandGroup) Init()

type Context

+ State interface{}

+ type GetState = func(ctx *Context) error

type Router

+ GetState GetState

type RouterConfig

+ GetState GetState

v1.11.1

Sep 25, 2020

v1.11.0

Sep 25, 2020

Changes in this version

+ func EmbedsPaginatorWithLifetime(ctx *Context, Pages []*disgord.Embed, InitialPage uint, ...) (err error)

+ func GuildTransformer(ctx *Context, Arg string) (guild interface{}, err error)

type Context

+ func (c *Context) DisplayEmbedMenuWithLifetime(m *EmbedMenu, lifetime *EmbedLifetimeOptions) error

+ type EmbedLifetimeOptions struct

+ AfterDelete func()

+ BeforeDelete func()

+ InactiveLifetime time.Duration

+ MaximumLifetime time.Duration

+ func (l *EmbedLifetimeOptions) Start(ChannelID, MessageID disgord.Snowflake, client disgord.Session)

type EmbedMenu

+ func (e *EmbedMenu) AddExitButton()

type InMemoryMessageCacheStorageAdapter

+ func (c *InMemoryMessageCacheStorageAdapter) BulkGetAndDelete(ChannelID disgord.Snowflake, MessageIDs []disgord.Snowflake) []*disgord.Message

type MessageCacheHandler

+ BulkDeletedCallback func(s disgord.Session, channelID disgord.Snowflake, messages []*disgord.Message)

type MessageCacheStorageAdapter

+ BulkGetAndDelete func(ChannelID disgord.Snowflake, MessageIDs []disgord.Snowflake) []*disgord.Message

v1.10.1

Jul 25, 2020

v1.10.0

Jul 25, 2020

Changes in this version

type InMemoryMessageCacheStorageAdapter

+ func (c *InMemoryMessageCacheStorageAdapter) Update(ChannelID, MessageID disgord.Snowflake, Message *disgord.Message) (old *disgord.Message)

+ type MessageCacheHandler struct

+ DeletedCallback func(s disgord.Session, msg *disgord.Message)

+ IgnoreBots bool

+ Limit int

+ MessageCacheStorageAdapter MessageCacheStorageAdapter

+ UpdatedCallback func(s disgord.Session, before, after *disgord.Message)

type MessageCacheStorageAdapter

+ Update func(ChannelID, MessageID disgord.Snowflake, Message *disgord.Message) (old *disgord.Message)

type Router

+ MessageCacheHandler *MessageCacheHandler

type RouterConfig

+ MessageCacheHandler *MessageCacheHandler

v1.9.0

Jul 20, 2020

Changes in this version

type Context

+ func (c *Context) EmbedTextFailover(EmbedGenerator func() *disgord.Embed, TextGenerator func() string) (*disgord.Message, error)

v1.8.0

Jul 14, 2020

Changes in this version

type Category

+ Cooldown Cooldown

+ func (c *Category) GetCooldown() Cooldown

type CategoryInterface

+ GetCooldown func() Cooldown

+ type ChannelCooldown struct

+ MaxRuns uint

+ UsageExpires time.Duration

+ func (c *ChannelCooldown) Check(ctx *Context) (string, bool)

+ func (c *ChannelCooldown) Clear()

+ func (c *ChannelCooldown) Init()

type Command

+ Cooldown Cooldown

+ func (obj Command) GetCooldown() Cooldown

type CommandInterface

+ GetCooldown func() Cooldown

+ type CommandOnCooldown struct

+ Message string

+ func (c *CommandOnCooldown) Error() string

+ type Cooldown interface

+ Check func(ctx *Context) (message string, ok bool)

+ Clear func()

+ Init func()

+ func MultipleCooldowns(cooldowns ...Cooldown) Cooldown

+ type GuildCooldown struct

+ MaxRuns uint

+ UsageExpires time.Duration

+ func (g *GuildCooldown) Check(ctx *Context) (string, bool)

+ func (g *GuildCooldown) Clear()

+ func (g *GuildCooldown) Init()

type Router

+ Cooldown Cooldown

type RouterConfig

+ Cooldown Cooldown

+ type UserCooldown struct

+ MaxRuns uint

+ UsageExpires time.Duration

+ func (u *UserCooldown) Check(ctx *Context) (string, bool)

+ func (u *UserCooldown) Clear()

+ func (u *UserCooldown) Init()

v1.7.0

Jul 10, 2020

v1.6.0

Jul 10, 2020

Changes in this version

type ArgTransformer

+ Default interface{}

v1.5.0

Jul 5, 2020

Changes in this version

type Context

+ WaitManager *WaitManager

+ type WaitManager struct

+ func (w *WaitManager) WaitForChannelCreate(ctx context.Context, ...) *disgord.ChannelCreate

+ func (w *WaitManager) WaitForChannelDelete(ctx context.Context, ...) *disgord.ChannelDelete

+ func (w *WaitManager) WaitForChannelPinsUpdate(ctx context.Context, ...) *disgord.ChannelPinsUpdate

+ func (w *WaitManager) WaitForChannelUpdate(ctx context.Context, ...) *disgord.ChannelUpdate

+ func (w *WaitManager) WaitForGuildBanAdd(ctx context.Context, ...) *disgord.GuildBanAdd

+ func (w *WaitManager) WaitForGuildBanRemove(ctx context.Context, ...) *disgord.GuildBanRemove

+ func (w *WaitManager) WaitForGuildCreate(ctx context.Context, ...) *disgord.GuildCreate

+ func (w *WaitManager) WaitForGuildDelete(ctx context.Context, ...) *disgord.GuildDelete

+ func (w *WaitManager) WaitForGuildEmojisUpdate(ctx context.Context, ...) *disgord.GuildEmojisUpdate

+ func (w *WaitManager) WaitForGuildMemberAdd(ctx context.Context, ...) *disgord.GuildMemberAdd

+ func (w *WaitManager) WaitForGuildMemberRemove(ctx context.Context, ...) *disgord.GuildMemberRemove

+ func (w *WaitManager) WaitForGuildMemberUpdate(ctx context.Context, ...) *disgord.GuildMemberUpdate

+ func (w *WaitManager) WaitForGuildRoleCreate(ctx context.Context, ...) *disgord.GuildRoleCreate

+ func (w *WaitManager) WaitForGuildRoleDelete(ctx context.Context, ...) *disgord.GuildRoleDelete

+ func (w *WaitManager) WaitForGuildRoleUpdate(ctx context.Context, ...) *disgord.GuildRoleUpdate

+ func (w *WaitManager) WaitForGuildUpdate(ctx context.Context, ...) *disgord.GuildUpdate

+ func (w *WaitManager) WaitForInviteCreate(ctx context.Context, ...) *disgord.InviteCreate

+ func (w *WaitManager) WaitForInviteDelete(ctx context.Context, ...) *disgord.InviteDelete

+ func (w *WaitManager) WaitForMessageCreate(ctx context.Context, ...) *disgord.MessageCreate

+ func (w *WaitManager) WaitForMessageDelete(ctx context.Context, ...) *disgord.MessageDelete

+ func (w *WaitManager) WaitForMessageDeleteBulk(ctx context.Context, ...) *disgord.MessageDeleteBulk

+ func (w *WaitManager) WaitForMessageReactionAdd(ctx context.Context, ...) *disgord.MessageReactionAdd

+ func (w *WaitManager) WaitForMessageReactionRemove(ctx context.Context, ...) *disgord.MessageReactionRemove

+ func (w *WaitManager) WaitForMessageReactionRemoveAll(ctx context.Context, ...) *disgord.MessageReactionRemoveAll

+ func (w *WaitManager) WaitForMessageUpdate(ctx context.Context, ...) *disgord.MessageUpdate

+ func (w *WaitManager) WaitForPresenceUpdate(ctx context.Context, ...) *disgord.PresenceUpdate

+ func (w *WaitManager) WaitForTypingStart(ctx context.Context, ...) *disgord.TypingStart

+ func (w *WaitManager) WaitForUserUpdate(ctx context.Context, ...) *disgord.UserUpdate

+ func (w *WaitManager) WaitForVoiceServerUpdate(ctx context.Context, ...) *disgord.VoiceServerUpdate

+ func (w *WaitManager) WaitForVoiceStateUpdate(ctx context.Context, ...) *disgord.VoiceStateUpdate

+ func (w *WaitManager) WaitForWebhooksUpdate(ctx context.Context, ...) *disgord.WebhooksUpdate

v1.4.0

Jul 1, 2020

Changes in this version

+ type PermissionCheckSettings uint8

+ const CheckBotChannelPermissions

+ const CheckBotUserPermissions

+ const CheckMembersChannelPermissions

+ const CheckMembersUserPermissions

v1.3.1

Jun 17, 2020

v1.3.0

Jun 17, 2020

Changes in this version

type Context

+ ShardID uint

+ func (c *Context) Guild() (*disgord.Guild, error)

+ func (c *Context) PermissionVerifiedReply(data ...interface{}) (*disgord.Message, error)

type RouterConfig

+ MessagePads int

v1.2.1

Jun 7, 2020

v1.2.0

Jun 7, 2020

Changes in this version

+ type GuildChannelRelationshipManagement interface

+ AddChannelID func(GuildID, ChannelID disgord.Snowflake)

+ GetAllChannelIDs func(GuildID disgord.Snowflake) []disgord.Snowflake

+ RemoveChannelID func(GuildID, ChannelID disgord.Snowflake)

v1.1.3

Jun 7, 2020

v1.1.2

Jun 6, 2020

v1.1.1

May 31, 2020

v1.1.0

May 30, 2020

v1.0.0

May 28, 2020

Changes in this version

+ var ADD_REACTIONS = permissionsWrapper("Add Reactions", 0x00000040)

+ var ADMINISTRATOR = permissionsWrapper("Administrator", 0x00000008)

+ var ATTACH_FILES = permissionsWrapper("Attach Files", 0x00008000)

+ var BAN_MEMBERS = permissionsWrapper("Ban Members", 0x00000004)

+ var CHANGE_NICKNAME = permissionsWrapper("Change Nickname", 0x04000000)

+ var CONNECT = permissionsWrapper("Connect", 0x00100000)

+ var CREATE_INSTANT_INVITE = permissionsWrapper("Create Instant Invite", 0x00000001)

+ var DEAFEN_MEMBERS = permissionsWrapper("Deafen Members", 0x00800000)

+ var EMBED_LINKS = permissionsWrapper("Embed Links", 0x00004000)

+ var KICK_MEMBERS = permissionsWrapper("Kick Members", 0x00000002)

+ var MANAGE_CHANNELS = permissionsWrapper("Manage Channels", 0x00000010)

+ var MANAGE_EMOJIS = permissionsWrapper("Manage Emojis", 0x40000000)

+ var MANAGE_GUILD = permissionsWrapper("Manage Guild", 0x00000020)

+ var MANAGE_MESSAGES = permissionsWrapper("Manage Messages", 0x00002000)

+ var MANAGE_NICKNAMES = permissionsWrapper("Manage Nicknames", 0x08000000)

+ var MANAGE_ROLES = permissionsWrapper("Manage Roles", 0x10000000)

+ var MANAGE_WEBHOOKS = permissionsWrapper("Manage Webhooks", 0x20000000)

+ var MENTION_EVERYONE = permissionsWrapper("Mention Everyone", 0x00020000)

+ var MOVE_MEMBERS = permissionsWrapper("Move Members", 0x01000000)

+ var MUTE_MEMBERS = permissionsWrapper("Mute Members", 0x00400000)

+ var PRIORITY_SPEAKER = permissionsWrapper("Priority Speaker", 0x00000100)

+ var READ_MESSAGE_HISTORY = permissionsWrapper("Read Message History", 0x00010000)

+ var SEND_MESSAGES = permissionsWrapper("Send Messages", 0x00000800)

+ var SEND_TTS_MESSAGES = permissionsWrapper("Send Tts Messages", 0x00001000)

+ var SPEAK = permissionsWrapper("Speak", 0x00200000)

+ var STREAM = permissionsWrapper("Stream", 0x00000200)

+ var USE_EXTERNAL_EMOJIS = permissionsWrapper("Use External Emojis", 0x00040000)

+ var USE_VAD = permissionsWrapper("Use Vad", 0x02000000)

+ var VIEW_AUDIT_LOG = permissionsWrapper("View Audit Log", 0x00000080)

+ var VIEW_CHANNEL = permissionsWrapper("View Channel", 0x00000400)

+ func AnyTransformer(Transformers ...func(ctx *Context, Arg string) (interface{}, error)) func(ctx *Context, Arg string) (item interface{}, err error)

+ func BooleanTransformer(_ *Context, Arg string) (interface{}, error)

+ func ChannelTransformer(ctx *Context, Arg string) (channel interface{}, err error)

+ func CommandHasPermission(ctx *Context, c CommandInterface) error

+ func DurationTransformer(_ *Context, Arg string) (duration interface{}, err error)

+ func EmbedsPaginator(ctx *Context, Pages []*disgord.Embed) error

+ func IntTransformer(_ *Context, Arg string) (interface{}, error)

+ func MemberTransformer(ctx *Context, Arg string) (member interface{}, err error)

+ func MentionPrefix(ctx *Context, r *StringIterator) bool

+ func MessageURLTransformer(ctx *Context, Arg string) (message interface{}, err error)

+ func MultiplePrefixCheckers(Handlers ...PrefixCheck) func(ctx *Context, r *StringIterator) bool

+ func RoleTransformer(ctx *Context, Arg string) (role interface{}, err error)

+ func StaticPrefix(Prefix string) func(_ *Context, r *StringIterator) bool

+ func StringTransformer(_ *Context, Arg string) (interface{}, error)

+ func UIntTransformer(_ *Context, Arg string) (interface{}, error)

+ func UserTransformer(ctx *Context, Arg string) (user interface{}, err error)

+ type ArgTransformer struct

+ Function func(ctx *Context, Arg string) (interface{}, error)

+ Greedy bool

+ Optional bool

+ Remainder bool

+ type Category struct

+ Description string

+ Middleware []Middleware

+ Name string

+ PermissionValidators []PermissionValidator

+ func (c *Category) GetDescription() string

+ func (c *Category) GetMiddleware() []Middleware

+ func (c *Category) GetName() string

+ func (c *Category) GetPermissionValidators() []PermissionValidator

+ type CategoryInterface interface

+ GetDescription func() string

+ GetMiddleware func() []Middleware

+ GetName func() string

+ GetPermissionValidators func() []func(ctx *Context) (string, bool)

+ type ChildMenuOptions struct

+ AfterAction func()

+ BeforeAction func()

+ Button *MenuButton

+ Embed *disgord.Embed

+ type Command struct

+ Aliases []string

+ ArgTransformers []ArgTransformer

+ Category CategoryInterface

+ CommandAttributes interface{}

+ Description string

+ Function func(ctx *Context) error

+ Middleware []Middleware

+ Name string

+ PermissionValidators []PermissionValidator

+ Usage string

+ func (c *Command) CommandFunction(ctx *Context) error

+ func (c *Command) GetAliases() []string

+ func (c *Command) GetArgTransformers() []ArgTransformer

+ func (c *Command) GetCategory() CategoryInterface

+ func (c *Command) GetDescription() string

+ func (c *Command) GetMiddleware() []Middleware

+ func (c *Command) GetName() string

+ func (c *Command) GetPermissionValidators() []PermissionValidator

+ func (c *Command) GetUsage() string

+ func (c *Command) HasPermission(ctx *Context) error

+ func (c *Command) Init()

+ type CommandBasics struct

+ Aliases []string

+ ArgTransformers []ArgTransformer

+ Category CategoryInterface

+ Description string

+ Middleware []Middleware

+ Name string

+ PermissionValidators []PermissionValidator

+ Usage string

+ func (c *CommandBasics) GetAliases() []string

+ func (c *CommandBasics) GetArgTransformers() []ArgTransformer

+ func (c *CommandBasics) GetCategory() CategoryInterface

+ func (c *CommandBasics) GetDescription() string

+ func (c *CommandBasics) GetMiddleware() []Middleware

+ func (c *CommandBasics) GetName() string

+ func (c *CommandBasics) GetPermissionValidators() []PermissionValidator

+ func (c *CommandBasics) GetUsage() string

+ type CommandBlank struct

+ func (c *CommandBlank) Error() string

+ type CommandInterface interface

+ CommandFunction func(ctx *Context) error

+ GetAliases func() []string

+ GetArgTransformers func() []ArgTransformer

+ GetCategory func() CategoryInterface

+ GetDescription func() string

+ GetMiddleware func() []Middleware

+ GetName func() string

+ GetPermissionValidators func() []PermissionValidator

+ GetUsage func() string

+ Init func()

+ type CommandNotFound struct

+ func (c *CommandNotFound) Error() string

+ type Context struct

+ Args []interface{}

+ BotUser *disgord.User

+ Command CommandInterface

+ Message *disgord.Message

+ MiddlewareParams map[string]interface{}

+ Prefix string

+ RawArgs string

+ Router *Router

+ Session disgord.Session

+ func (c *Context) BotMember() (*disgord.Member, error)

+ func (c *Context) Channel() (*disgord.Channel, error)

+ func (c *Context) DisplayEmbedMenu(m *EmbedMenu) error

+ func (c *Context) Replay() error

+ func (c *Context) Reply(data ...interface{}) (*disgord.Message, error)

+ func (c *Context) WaitForMessage(CheckFunc func(s disgord.Session, msg *disgord.Message) bool) *disgord.Message

+ type CustomCommandsHandler = func(ctx *Context, cmdname string, r *StringIterator) (bool, error)

+ type DeletedMessageHandler struct

+ Callback func(s disgord.Session, msg *disgord.Message)

+ Limit int

+ MessageCacheStorageAdapter MessageCacheStorageAdapter

+ type EmbedMenu struct

+ Embed *disgord.Embed

+ MenuInfo *MenuInfo

+ Reactions *MenuReactions

+ func NewEmbedMenu(embed *disgord.Embed, ctx *Context) *EmbedMenu

+ func (e *EmbedMenu) AddBackButton()

+ func (e *EmbedMenu) AddParentMenu(Menu *EmbedMenu)

+ func (e *EmbedMenu) Display(ChannelID, MessageID disgord.Snowflake, client disgord.Session) error

+ func (e *EmbedMenu) NewChildMenu(options *ChildMenuOptions) *EmbedMenu

+ type ErrorHandler = func(ctx *Context, err error) bool

+ type InMemoryMessageCacheStorageAdapter struct

+ func (c *InMemoryMessageCacheStorageAdapter) AddChannelID(GuildID, ChannelID disgord.Snowflake)

+ func (c *InMemoryMessageCacheStorageAdapter) Delete(ChannelID, MessageID disgord.Snowflake)

+ func (c *InMemoryMessageCacheStorageAdapter) DeleteChannelsMessages(ChannelID disgord.Snowflake)

+ func (c *InMemoryMessageCacheStorageAdapter) GetAllChannelIDs(GuildID disgord.Snowflake) []disgord.Snowflake

+ func (c *InMemoryMessageCacheStorageAdapter) GetAndDelete(ChannelID, MessageID disgord.Snowflake) *disgord.Message

+ func (c *InMemoryMessageCacheStorageAdapter) Init()

+ func (c *InMemoryMessageCacheStorageAdapter) RemoveChannelID(GuildID, ChannelID disgord.Snowflake)

+ func (c *InMemoryMessageCacheStorageAdapter) RemoveGuild(GuildID disgord.Snowflake)

+ func (c *InMemoryMessageCacheStorageAdapter) Set(ChannelID, MessageID disgord.Snowflake, Message *disgord.Message, Limit uint)

+ type IncorrectPermissions struct

+ func (c *IncorrectPermissions) Error() string

+ type InvalidArgCount struct

+ func (c *InvalidArgCount) Error() string

+ type InvalidTransformation struct

+ Description string

+ func (c *InvalidTransformation) Error() string

+ type MenuButton struct

+ Description string

+ Emoji string

+ Name string

+ type MenuInfo struct

+ Author string

+ Info []string

+ type MenuReaction struct

+ Button *MenuButton

+ Function func(ChannelID, MessageID disgord.Snowflake, _ *EmbedMenu, client disgord.Session)

+ type MenuReactions struct

+ ReactionSlice []MenuReaction

+ func (mr *MenuReactions) Add(reaction MenuReaction)

+ type MessageCacheStorageAdapter interface

+ AddChannelID func(GuildID, ChannelID disgord.Snowflake)

+ Delete func(ChannelID, MessageID disgord.Snowflake)

+ DeleteChannelsMessages func(ChannelID disgord.Snowflake)

+ GetAllChannelIDs func(GuildID disgord.Snowflake) []disgord.Snowflake

+ GetAndDelete func(ChannelID, MessageID disgord.Snowflake) *disgord.Message

+ Init func()

+ RemoveChannelID func(GuildID, ChannelID disgord.Snowflake)

+ RemoveGuild func(GuildID disgord.Snowflake)

+ Set func(ChannelID, MessageID disgord.Snowflake, Message *disgord.Message, Limit uint)

+ type Middleware = func(ctx *Context) error

+ type PanicError struct

+ func (c *PanicError) Error() string

+ type PermissionValidator = func(ctx *Context) (string, bool)

+ type PrefixCheck = func(ctx *Context, r *StringIterator) bool

+ type Router struct

+ BotUser *disgord.User

+ CustomCommandsHandler CustomCommandsHandler

+ DeletedMessageHandler *DeletedMessageHandler

+ PrefixCheck PrefixCheck

+ func NewRouter(Config *RouterConfig) *Router

+ func (r *Router) AddErrorHandler(Handler ErrorHandler)

+ func (r *Router) CommandProcessor(s disgord.Session, msg *disgord.Message)

+ func (r *Router) GetAllCommands() []CommandInterface

+ func (r *Router) GetCommand(Name string) CommandInterface

+ func (r *Router) GetCommandsOrderedByCategory() map[CategoryInterface][]CommandInterface

+ func (r *Router) Hook(s disgord.Session)

+ func (r *Router) RemoveCommand(c CommandInterface)

+ func (r *Router) SetCommand(c CommandInterface)

+ type RouterConfig struct

+ DeletedMessageHandler *DeletedMessageHandler

+ ErrorHandlers []ErrorHandler

+ Middleware []Middleware

+ PermissionValidators []PermissionValidator

+ PrefixCheck PrefixCheck

+ type StringIterator struct

+ Pos uint

+ Text string

+ func (s *StringIterator) GetChar() (char uint8, err error)

+ func (s *StringIterator) GetRemainder(FillIterator bool) (remainder string, err error)

+ func (s *StringIterator) Rewind(N uint)

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