birchwood.protocol.formatting

Message formatting utilities

Members

Enums

ControlCode
enum ControlCode

Control codes

SimpleColor
enum SimpleColor

Simple color codes

Functions

bold
string bold(string text)

Formats the provided text as bold

italics
string italics(string text)

Formats the provided text in italics

monospace
string monospace(string text)

Formats the text as monospaced

resetForegroundBackground
string resetForegroundBackground()

Generate a string that resets the foreground and background colors

setForeground
string setForeground(string color)

Generates a string that changes the foreground color

setForeground
string setForeground(SimpleColor color)

Generates a string that changes the foreground color (except enum)

setForegroundBackground
string setForegroundBackground(string fg, string bg)

Generate a string that sets the foreground and background color

setForegroundBackground
string setForegroundBackground(SimpleColor fg, SimpleColor bg)

Generate a string that sets the foreground and background color (except enum)

strikethrough
string strikethrough(string text)

Formats the text as strikethroughed

underline
string underline(string text)

Formats the text as underlined

Meta