templates

Documentation

Index

• Constants
• Variables
• func CreateEmbed(values ...interface{}) (*discordgo.MessageEmbed, error)
• func CreateMessageEdit(values ...interface{}) (*discordgo.MessageEdit, error)
• func CreateMessageSend(values ...interface{}) (*discordgo.MessageSend, error)
• func Dictionary(values ...interface{}) (map[interface{}]interface{}, error)
• func LimitWriter(w io.Writer, n int64) io.Writer
• func MaybeScheduledDeleteMessage(guildID, channelID, messageID int64, delaySeconds int)
• func RegisterSetupFunc(f ContextSetupFunc)
• func TODO()
• func ToByte(from interface{}) []byte
• func ToDuration(from interface{}) time.Duration
• func ToFloat64(from interface{}) float64
• func ToInt64(from interface{}) int64
• func ToRune(from interface{}) []rune
• func ToString(from interface{}) string
• type Context
  • func NewContext(gs *dstate.GuildState, cs *dstate.ChannelState, ms *dstate.MemberState) *Context
  • func (c *Context) ChannelArg(v interface{}) int64
  • func (c *Context) Execute(source string) (string, error)
  • func (c *Context) ExecuteAndSendWithErrors(source string, channelID int64) error
  • func (c *Context) IncreaseCheckCallCounter(key string, limit int) bool
  • func (c *Context) IncreaseCheckCallCounterPremium(key string, normalLimit, premiumLimit int) bool
  • func (c *Context) IncreaseCheckGenericAPICall() bool
  • func (c *Context) IncreaseCheckStateLock() bool
  • func (c *Context) LogEntry() *logrus.Entry
  • func (c *Context) MessageSend(content string) *discordgo.MessageSend
  • func (c *Context) Parse(source string) (*template.Template, error)
  • func (c *Context) SendResponse(content string) (*discordgo.Message, error)
• type ContextSetupFunc
• type SDict
  • func StringKeyDictionary(values ...interface{}) (SDict, error)
  • func (d SDict) Del(key string) string
  • func (d SDict) Get(key string) interface{}
  • func (d SDict) Set(key string, value interface{}) string
• type Slice
  • func CreateSlice(values ...interface{}) (Slice, error)
  • func (s Slice) Append(item interface{}) (interface{}, error)
  • func (s Slice) AppendSlice(slice interface{}) (interface{}, error)
  • func (s Slice) Set(index int, item interface{}) (string, error)
  • func (s Slice) StringSlice(flag ...bool) interface{}

Constants

const (
	MaxOpsNormal  = 1000000
	MaxOpsPremium = 2500000
)

const MaxStringLength = 1000000

Variables

var ErrStringTooLong = errors.NewPlain("String is too long (max 1MB)")

var ErrTooManyAPICalls = errors.New("Too many potential discord api calls function")

var ErrTooManyCalls = errors.New("Too many calls to this function")

var GuildPremiumFunc func(guildID int64) (bool, error)

set by the premium package to return wether this guild is premium or not

var (
	StandardFuncMap = map[string]interface{}{

		"str":        ToString,
		"toString":   ToString,
		"toInt":      tmplToInt,
		"toInt64":    ToInt64,
		"toFloat":    ToFloat64,
		"toDuration": ToDuration,
		"toRune":     ToRune,
		"toByte":     ToByte,

		"joinStr":   joinStrings,
		"lower":     strings.ToLower,
		"upper":     strings.ToUpper,
		"slice":     slice,
		"urlescape": url.PathEscape,
		"split":     strings.Split,
		"title":     strings.Title,

		"add":               add,
		"sub":               tmplSub,
		"mult":              tmplMult,
		"div":               tmplDiv,
		"mod":               tmplMod,
		"fdiv":              tmplFDiv,
		"sqrt":              tmplSqrt,
		"pow":               tmplPow,
		"log":               tmplLog,
		"round":             tmplRound,
		"roundCeil":         tmplRoundCeil,
		"roundFloor":        tmplRoundFloor,
		"roundEven":         tmplRoundEven,
		"humanizeThousands": tmplHumanizeThousands,

		"dict":               Dictionary,
		"sdict":              StringKeyDictionary,
		"cembed":             CreateEmbed,
		"cslice":             CreateSlice,
		"complexMessage":     CreateMessageSend,
		"complexMessageEdit": CreateMessageEdit,

		"formatTime":  tmplFormatTime,
		"json":        tmplJson,
		"in":          in,
		"inFold":      inFold,
		"roleAbove":   roleIsAbove,
		"adjective":   common.RandomAdjective,
		"noun":        common.RandomNoun,
		"randInt":     randInt,
		"shuffle":     shuffle,
		"seq":         sequence,
		"currentTime": tmplCurrentTime,
		"newDate":     tmplNewDate,

		"escapeHere": func(s string) (string, error) {
			return "", errors.New("function is removed in favor of better direct control over mentions, join support server and read the announcements for more info.")
		},
		"escapeEveryone": func(s string) (string, error) {
			return "", errors.New("function is removed in favor of better direct control over mentions, join support server and read the announcements for more info.")
		},
		"escapeEveryoneHere": func(s string) (string, error) {
			return "", errors.New("function is removed in favor of better direct control over mentions, join support server and read the announcements for more info.")
		},

		"humanizeDurationHours":   tmplHumanizeDurationHours,
		"humanizeDurationMinutes": tmplHumanizeDurationMinutes,
		"humanizeDurationSeconds": tmplHumanizeDurationSeconds,
		"humanizeTimeSinceDays":   tmplHumanizeTimeSinceDays,
	}
)

Functions

func CreateEmbed

func CreateEmbed(values ...interface{}) (*discordgo.MessageEmbed, error)

func CreateMessageEdit

func CreateMessageEdit(values ...interface{}) (*discordgo.MessageEdit, error)

func CreateMessageSend

func CreateMessageSend(values ...interface{}) (*discordgo.MessageSend, error)

func Dictionary

func Dictionary(values ...interface{}) (map[interface{}]interface{}, error)

dictionary creates a map[string]interface{} from the given parameters by walking the parameters and treating them as key-value pairs. The number of parameters must be even.

func LimitWriter

func LimitWriter(w io.Writer, n int64) io.Writer

LimitWriter works like io.LimitReader. It writes at most n bytes to the underlying Writer. It returns io.ErrShortWrite if more than n bytes are attempted to be written.

func MaybeScheduledDeleteMessage

func MaybeScheduledDeleteMessage(guildID, channelID, messageID int64, delaySeconds int)

func RegisterSetupFunc

func RegisterSetupFunc(f ContextSetupFunc)

func TODO

func TODO()

func ToByte

func ToByte(from interface{}) []byte

func ToDuration

func ToDuration(from interface{}) time.Duration

func ToFloat64

func ToFloat64(from interface{}) float64

func ToInt64

func ToInt64(from interface{}) int64

func ToRune

func ToRune(from interface{}) []rune

func ToString

func ToString(from interface{}) string

Types

type Context

type Context struct {
	Name string

	GS      *dstate.GuildState
	MS      *dstate.MemberState
	Msg     *discordgo.Message
	BotUser *discordgo.User

	ContextFuncs map[string]interface{}
	Data         map[string]interface{}
	Counters     map[string]int

	FixedOutput string

	IsPremium bool

	RegexCache map[string]*regexp.Regexp

	CurrentFrame *contextFrame
	// contains filtered or unexported fields
}

func NewContext

func NewContext(gs *dstate.GuildState, cs *dstate.ChannelState, ms *dstate.MemberState) *Context

func (*Context) ChannelArg

func (c *Context) ChannelArg(v interface{}) int64

func (*Context) Execute

func (c *Context) Execute(source string) (string, error)

func (*Context) ExecuteAndSendWithErrors

func (c *Context) ExecuteAndSendWithErrors(source string, channelID int64) error

func (*Context) IncreaseCheckCallCounter

func (c *Context) IncreaseCheckCallCounter(key string, limit int) bool

IncreaseCheckCallCounter Returns true if key is above the limit

func (*Context) IncreaseCheckCallCounterPremium

func (c *Context) IncreaseCheckCallCounterPremium(key string, normalLimit, premiumLimit int) bool

IncreaseCheckCallCounter Returns true if key is above the limit

func (*Context) IncreaseCheckGenericAPICall

func (c *Context) IncreaseCheckGenericAPICall() bool

func (*Context) IncreaseCheckStateLock

func (c *Context) IncreaseCheckStateLock() bool

func (*Context) LogEntry

func (c *Context) LogEntry() *logrus.Entry

func (*Context) MessageSend

func (c *Context) MessageSend(content string) *discordgo.MessageSend

func (*Context) Parse

func (c *Context) Parse(source string) (*template.Template, error)

func (*Context) SendResponse

func (c *Context) SendResponse(content string) (*discordgo.Message, error)

SendResponse sends the response and handles reactions and the like

type ContextSetupFunc

type ContextSetupFunc func(ctx *Context)

type SDict

type SDict map[string]interface{}

func StringKeyDictionary

func StringKeyDictionary(values ...interface{}) (SDict, error)

func (SDict) Del

func (d SDict) Del(key string) string

func (SDict) Get

func (d SDict) Get(key string) interface{}

func (SDict) Set

func (d SDict) Set(key string, value interface{}) string

type Slice

type Slice []interface{}

func CreateSlice

func CreateSlice(values ...interface{}) (Slice, error)

func (Slice) Append

func (s Slice) Append(item interface{}) (interface{}, error)

func (Slice) AppendSlice

func (s Slice) AppendSlice(slice interface{}) (interface{}, error)

func (Slice) Set

func (s Slice) Set(index int, item interface{}) (string, error)

func (Slice) StringSlice

func (s Slice) StringSlice(flag ...bool) interface{}