Class ChatColor

constructor

• new ChatColor(code, color?): ChatColor

• Class ChatColor Constructor.

  Parameters

  • code: string

    The color code as a string.

  • Optional color: number

    The color code as a hexadecimal number. Can be undefined.

  Returns ChatColor

Static Readonly ALL_COLORS

Static Readonly AQUA

Static Readonly BLACK

Static Readonly BLUE

Static Readonly BOLD

Static Readonly DARK_AQUA

Static Readonly DARK_BLUE

Static Readonly DARK_GRAY

Static Readonly DARK_GREEN

Static Readonly DARK_PURPLE

Static Readonly DARK_RED

Static Readonly GOLD

Static Readonly GRAY

Static Readonly GREEN

Static Readonly ITALIC

Static Readonly LIGHT_PURPLE

Static Readonly MATERIAL_AMETHYST

Static Readonly MATERIAL_COPPER

Static Readonly MATERIAL_DIAMOND

Static Readonly MATERIAL_EMERALD

Static Readonly MATERIAL_GOLD

Static Readonly MATERIAL_IRON

Static Readonly MATERIAL_LAPIS

Static Readonly MATERIAL_NETHERITE

Static Readonly MATERIAL_QUARTZ

Static Readonly MATERIAL_REDSTONE

Static Readonly MINECOIN_GOLD

Static Readonly OBFUSCATED

Static Readonly RED

Static Readonly RESET

Static Readonly VALUES

Static Readonly WHITE

Static Readonly YELLOW

getBlue

• getBlue(): undefined | number

• Retrieves the blue value of a color.

  Returns undefined | number

  The blue value of the color.

getCode

• getCode(): string

• Retrieves the format code associated with the chat color.

  Returns string

  The format code of the chat color.

getGreen

• getGreen(): undefined | number

• Retrieves the green value of the current color.

  Returns undefined | number

  The green value of the color, or undefined if it is not set.

getRed

• getRed(): undefined | number

• Retrieve the value of the red component.

  Returns undefined | number

  The value of the red component, or undefined if it is not set.

toHex

• toHex(): undefined | string

• Returns the hexadecimal string representation of the color code

  Returns undefined | string

  The hexadecimal representation of the color.

toRGB

• toRGB(): undefined | number

• Returns the color code of the ChatColor instance.

  Returns undefined | number

  The color code of this ChatColor instance.

toString

• toString(): string

• Returns the string representation of the ChatColor instance, which includes the PREFIX followed by the color code.

  Returns string

  A string representing the ChatColor instance

Static findClosestColor

• findClosestColor(r, g, b): ChatColor

• Finds the closest ChatColor code for the given RGB values

  Parameters

  • r: number

    Red part of the color.

  • g: number

    Green part of the color.

  • b: number

    Blue part of the color.

  Returns ChatColor

  The closest ChatColor for the given RGB values.

Static stripColor

• stripColor(str): string

• Removes color codes from the specified string

  Parameters

  • str: string

    The string from which color codes will be removed.

  Returns string

  The string cleared from color codes.