diamondburned/arikawa
1
0
Fork 0
mirror of https://github.com/diamondburned/arikawa.git synced 2025-05-06 14:04:13 +00:00
Code Issues Releases Activity

Tweaked bot router docs

Browse source
This commit is contained in:
diamondburned (Forefront) 2020-01-19 19:46:48 -08:00
parent de37b58dd3
commit 1c9b45e051
1 changed files with 15 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
bot/ctx.go
View file

@ -13,6 +13,21 @@ import (
// TODO: add variadic arguments
// Context is the bot state for commands and subcommands.
//
// A command can be created by making it a method of Commands, or whatever
// struct was given to the constructor. This following example creates a command
// with a single integer argument (which can be ran with "~example 123"):
//
// func (c *Commands) Example(m *gateway.MessageCreateEvent, i int) error {
// _, err := c.Ctx.SendMessage(m.ChannelID, fmt.Sprintf("You sent: %d", i))
// return err
// }
//
// Commands' exported methods will all be used as commands. Messages are parsed
// with its first argument (the command) mapped accordingly to c.MapName, which
// capitalizes the first letter automatically to reflect the exported method
// name.
type Context struct {
*Subcommand
*state.State
@ -98,22 +113,6 @@ func Wait() {
// cmds := &Commands{}
// c, err := rfrouter.New(session, cmds)
//
// Example
//
// A command can be created by making it a method of Commands, or whatever
// struct was given to the constructor. This following example creates a command
// with a single integer argument (which can be ran with "~example 123"):
//
// func (c *Commands) Example(m *gateway.MessageCreateEvent, i int) error {
// _, err := c.Ctx.SendMessage(m.ChannelID, fmt.Sprintf("You sent: %d", i))
// return err
// }
//
// Commands' exported methods will all be used as commands. Messages are parsed
// with its first argument (the command) mapped accordingly to c.MapName, which
// capitalizes the first letter automatically to reflect the exported method
// name.
//
// The default prefix is "~", which means commands must start with "~" followed
// by the command name in the first argument, else it will be ignored.
//