helpers

Documentation

Index

• Constants
• type Embed
  • func NewEmbed() *Embed
  • func (e *Embed) AddField(name, value string, inline bool) *Embed
  • func (e *Embed) InlineAllFields() *Embed
  • func (e *Embed) SetAuthor(args ...string) *Embed
  • func (e *Embed) SetColor(clr int) *Embed
  • func (e *Embed) SetDescription(description string) *Embed
  • func (e *Embed) SetFooter(args ...string) *Embed
  • func (e *Embed) SetImage(args ...string) *Embed
  • func (e *Embed) SetThumbnail(args ...string) *Embed
  • func (e *Embed) SetTimestamp(t time.Time) *Embed
  • func (e *Embed) SetTitle(name string) *Embed
  • func (e *Embed) SetURL(URL string) *Embed
  • func (e *Embed) Truncate() *Embed
  • func (e *Embed) TruncateDescription() *Embed
  • func (e *Embed) TruncateFields() *Embed
  • func (e *Embed) TruncateFooter() *Embed
  • func (e *Embed) TruncateTitle() *Embed

Constants

const (
	EmbedLimitTitle       = 256
	EmbedLimitDescription = 2048
	EmbedLimitFieldValue  = 1024
	EmbedLimitFieldName   = 256
	EmbedLimitField       = 25
	EmbedLimitFooter      = 2048
	EmbedLimit            = 4000
)

Constants for message embed character limits

Types

type Embed

type Embed struct {
	*discordgo.MessageEmbed
}

Embed ...

func NewEmbed

func NewEmbed() *Embed

NewEmbed returns a new embed object

func (*Embed) AddField

func (e *Embed) AddField(name, value string, inline bool) *Embed

AddField [name] [value]

func (*Embed) InlineAllFields

func (e *Embed) InlineAllFields() *Embed

InlineAllFields sets all fields in the embed to be inline

func (*Embed) SetAuthor

func (e *Embed) SetAuthor(args ...string) *Embed

SetAuthor ...

func (*Embed) SetColor

func (e *Embed) SetColor(clr int) *Embed

SetColor ...

func (*Embed) SetDescription

func (e *Embed) SetDescription(description string) *Embed

SetDescription [desc]

func (*Embed) SetFooter

func (e *Embed) SetFooter(args ...string) *Embed

SetFooter [Text] [iconURL]

func (*Embed) SetImage

func (e *Embed) SetImage(args ...string) *Embed

SetImage ...

func (*Embed) SetThumbnail

func (e *Embed) SetThumbnail(args ...string) *Embed

SetThumbnail ...

func (*Embed) SetTimestamp

func (e *Embed) SetTimestamp(t time.Time) *Embed

SetTimestamp [timestamp]

func (*Embed) SetTitle

func (e *Embed) SetTitle(name string) *Embed

SetTitle ...

func (*Embed) SetURL

func (e *Embed) SetURL(URL string) *Embed

SetURL ...

func (*Embed) Truncate

func (e *Embed) Truncate() *Embed

Truncate truncates any embed value over the character limit.

func (*Embed) TruncateDescription

func (e *Embed) TruncateDescription() *Embed

TruncateDescription ...

func (*Embed) TruncateFields

func (e *Embed) TruncateFields() *Embed

TruncateFields truncates fields that are too long

func (*Embed) TruncateFooter

func (e *Embed) TruncateFooter() *Embed

TruncateFooter ...

func (*Embed) TruncateTitle

func (e *Embed) TruncateTitle() *Embed

TruncateTitle ...