embed

Documentation

Index

• Variables
• type Embed
  • func NewEmbed() *Embed
  • func (e *Embed) AddField(name, value string, flags ...bool) *Embed
  • func (e *Embed) InlineAllFields() *Embed
  • func (e *Embed) MakeFieldInline() *Embed
  • func (e *Embed) Send(ctx *dgc.Ctx) *discordgo.Message
  • 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) SetSubtext(text string) *Embed
  • func (e *Embed) SetThumbnail(args ...string) *Embed
  • func (e *Embed) SetTitle(name string) *Embed
  • func (e *Embed) SetURL(URL string) *Embed
  • func (e *Embed) ToCodeblock() []string
  • func (e *Embed) ToJson() string
  • func (e *Embed) ToString() []string
  • func (e *Embed) ToText() []string
  • func (e *Embed) ToURLEmbed() []string
  • 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

Variables

var (
	LimitTitle       = 256
	LimitDescription = 2048
	LimitFieldValue  = 1024
	LimitFieldName   = 256
	LimitField       = 25
	LimitFooter      = 2048
)

Types

type Embed

type Embed struct {
	*discordgo.MessageEmbed
	Subtext string
}

Embed ...

func NewEmbed

func NewEmbed() *Embed

NewEmbed returns a new embed object

func (*Embed) AddField

func (e *Embed) AddField(name, value string, flags ...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) MakeFieldInline

func (e *Embed) MakeFieldInline() *Embed

MakeFieldInline adds last field as InLine

func (*Embed) Send

func (e *Embed) Send(ctx *dgc.Ctx) *discordgo.Message

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) SetSubtext

func (e *Embed) SetSubtext(text string) *Embed

SetSubtext ...

func (*Embed) SetThumbnail

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

SetThumbnail ...

func (*Embed) SetTitle

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

SetTitle ...

func (*Embed) SetURL

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

SetURL ...

func (*Embed) ToCodeblock

func (e *Embed) ToCodeblock() []string

func (*Embed) ToJson

func (e *Embed) ToJson() string

func (*Embed) ToString

func (e *Embed) ToString() []string

func (*Embed) ToText

func (e *Embed) ToText() []string

func (*Embed) ToURLEmbed

func (e *Embed) ToURLEmbed() []string

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 ...