formatting

Documentation

Index

• type Item
  • func (i Item) Clean() string
  • func (i Item) HTML() string
  • func (i Item) Raw() (result string)
• type Result
  • func Parse(input interface{}) (*Result, error)

Types

type Item

type Item struct {
	Text       string                 `json:"text"`
	Color      *colors.Color          `json:"color,omitempty"`
	Decorators []decorators.Decorator `json:"decorators"`
}

Item is a single formatting item that contains a color and any optional formatting controls

func (Item) Clean

func (i Item) Clean() string

Clean returns the text only of the formatting item

func (Item) HTML

func (i Item) HTML() string

HTML returns the HTML representation of the format item. A <span> tag is used as well as the style and class attributes. Obfuscation is encoded as a class with the name 'minecraft-format-obfuscated'.

func (Item) Raw

func (i Item) Raw() (result string)

Raw returns the Minecraft encoding of the formatting (§ + formatting codes/color + text)

type Result

type Result struct {
	Tree  []Item `json:"-"`
	Raw   string `json:"raw"`
	Clean string `json:"clean"`
	HTML  string `json:"html"`
}

Result is a parsed structure of any Minecraft string encoded with color codes or format codes

func Parse

func Parse(input interface{}) (*Result, error)

Parse parses the formatting of any string or Chat object