com.shakelang.util.colorlib/com.shakelang.util.colorlib.functional

Package-level declarations

Types

class FormattedString(val contents: List<FormattedStringObject>, isBold: Boolean? = null, isItalic: Boolean? = null, isUnderlined: Boolean? = null, isStrikethrough: Boolean? = null, isInverted: Boolean? = null, val color: Formatting.FGColor? = null, val backgroundColor: Formatting.BGColor? = null) : FormattedStringObject

A formatted String that can be used to format Strings with colors and styles

FormattedStringObject

interface FormattedStringObject

A FormattedStringObject is an object that can be used in a FormattedString It can wrap a String or another FormattedString Its used to implement the FormattedStringObject.extends function

FormattedStringObjectString

class FormattedStringObjectString(val value: String) : FormattedStringObject

A FormattedStringObject that wraps a String

Functions

backgroundColor

fun String.backgroundColor(color: Formatting.BGColor): FormattedString

Format a string with the given background color

fun String.bg(color: Formatting.BGColor): FormattedString

Format a string with the given background color

bgBlack

fun bgBlack(contents: String): String

Make your background color black

bgBlack

fun String.bgBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLACK

bgBlue

fun bgBlue(contents: String): String

Make your background color blue

bgBlue

fun String.bgBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLUE

bgBrightBlack

fun String.bgBrightBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

bgBrightBlue

fun bgBrightBlue(contents: String): String

Make your background color bright blue

bgBrightBlue

fun String.bgBrightBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLUE

bgBrightCyan

fun bgBrightCyan(contents: String): String

Make your background color bright cyan

bgBrightCyan

fun String.bgBrightCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_CYAN

bgBrightGreen

fun bgBrightGreen(contents: String): String

Make your background color bright green

bgBrightGreen

fun String.bgBrightGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_GREEN

bgBrightPurple

fun bgBrightPurple(contents: String): String

Make your background color bright purple

bgBrightPurple

fun String.bgBrightPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_PURPLE

bgBrightRed

fun bgBrightRed(contents: String): String

Make your background color bright red

bgBrightRed

fun String.bgBrightRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_RED

bgBrightWhite

fun bgBrightWhite(contents: String): String

Make your background color bright white

bgBrightWhite

fun String.bgBrightWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.WHITE

bgBrightYellow

fun bgBrightYellow(contents: String): String

Make your background color bright yellow

bgBrightYellow

fun String.bgBrightYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_YELLOW

bgColor

fun String.bgColor(color: Formatting.BGColor): FormattedString

Format a string with the given background color

bgCyan

fun bgCyan(contents: String): String

Make your background color cyan

bgCyan

fun String.bgCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.CYAN

bgGreen

fun bgGreen(contents: String): String

Make your background color green

bgGreen

fun String.bgGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.GREEN

bgGrey

fun String.bgGrey(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

bgPurple

fun bgPurple(contents: String): String

Make your background color purple

bgPurple

fun String.bgPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.PURPLE

bgRed

fun bgRed(contents: String): String

Make your background color red

bgRed

fun String.bgRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.RED

bgWhite

fun bgWhite(contents: String): String

Make your background color white

bgWhite

fun String.bgWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.WHITE

bgYellow

fun bgYellow(contents: String): String

Make your background color yellow

bgYellow

fun String.bgYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.YELLOW

black

fun black(contents: String): String

Make your foreground color black

black

fun String.black(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLACK

blue

fun blue(contents: String): String

Make your foreground color blue

blue

fun String.blue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLUE

bold

fun bold(contents: String): String

Make your text bold

bold

fun String.bold(): FormattedString

Make the string bold

brightBlack

fun String.brightBlack(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLACK

brightBlue

fun brightBlue(contents: String): String

Make your foreground color bright blue

brightBlue

fun String.brightBlue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLUE

brightCyan

fun brightCyan(contents: String): String

Make your foreground color bright cyan

brightCyan

fun String.brightCyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_CYAN

brightGreen

fun brightGreen(contents: String): String

Make your foreground color bright green

brightGreen

fun String.brightGreen(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_GREEN

brightPurple

fun brightPurple(contents: String): String

Make your foreground color bright purple

brightPurple

fun String.brightPurple(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_PURPLE

brightRed

fun brightRed(contents: String): String

Make your foreground color bright red

brightRed

fun String.brightRed(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_RED

brightWhite

fun brightWhite(contents: String): String

Make your foreground color bright white

brightWhite

fun String.brightWhite(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_WHITE

brightYellow

fun brightYellow(contents: String): String

Make your foreground color bright yellow

brightYellow

fun String.brightYellow(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_YELLOW

color

fun String.color(color: Formatting.FGColor): FormattedString

Format a string with the given color

cyan

fun cyan(contents: String): String

Make your foreground color cyan

cyan

fun String.cyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.CYAN

fun String.fg(color: Formatting.FGColor): FormattedString

Format a string with the given color

fgBlack

fun fgBlack(contents: String): String

Make your foreground color black

fgBlack

fun String.fgBlack(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLACK

fgBlue

fun fgBlue(contents: String): String

Make your foreground color blue

fgBlue

fun String.fgBlue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLUE

fgBrightBlack

fun fgBrightBlack(contents: String): String

Make your foreground color gray

fgBrightBlack

fun String.fgBrightBlack(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLACK

fgBrightBlue

fun fgBrightBlue(contents: String): String

Make your foreground color bright blue

fgBrightBlue

fun String.fgBrightBlue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLUE

fgBrightCyan

fun fgBrightCyan(contents: String): String

Make your foreground color bright cyan

fgBrightCyan

fun String.fgBrightCyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_CYAN

fgBrightGreen

fun fgBrightGreen(contents: String): String

Make your foreground color bright green

fgBrightGreen

fun String.fgBrightGreen(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_GREEN

fgBrightPurple

fun fgBrightPurple(contents: String): String

Make your foreground color bright purple

fgBrightPurple

fun String.fgBrightPurple(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_PURPLE

fgBrightRed

fun fgBrightRed(contents: String): String

Make your foreground color bright red

fgBrightRed

fun String.fgBrightRed(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_RED

fgBrightWhite

fun fgBrightWhite(contents: String): String

Make your foreground color bright white

fgBrightWhite

fun String.fgBrightWhite(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_WHITE

fgBrightYellow

fun fgBrightYellow(contents: String): String

Make your foreground color bright yellow

fgBrightYellow

fun String.fgBrightYellow(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_YELLOW

fgColor

fun String.fgColor(color: Formatting.FGColor): FormattedString

Format a string with the given color

fgCyan

fun fgCyan(contents: String): String

Make your foreground color cyan

fgCyan

fun String.fgCyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.CYAN

fgGreen

fun fgGreen(contents: String): String

Make your foreground color green

fgGreen

fun String.fgGreen(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.GREEN

fgGrey

fun fgGrey(contents: String): String

Make your foreground color gray

fgGrey

fun String.fgGrey(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLACK

fgPurple

fun fgPurple(contents: String): String

Make your foreground color purple

fgPurple

fun String.fgPurple(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.PURPLE

fgRed

fun fgRed(contents: String): String

Make your foreground color red

fgRed

fun String.fgRed(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.RED

fgWhite

fun fgWhite(contents: String): String

Make your foreground color white

fgWhite

fun String.fgWhite(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.WHITE

fgYellow

fun fgYellow(contents: String): String

Make your foreground color yellow

fgYellow

fun String.fgYellow(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.YELLOW

format

fun String.format(isBold: Boolean? = null, isItalic: Boolean? = null, isUnderlined: Boolean? = null, isStrikethrough: Boolean? = null, isInverted: Boolean? = null, color: Formatting.FGColor? = null, backgroundColor: Formatting.BGColor? = null): FormattedString

Format a string with the given format

green