Class ChatColor

ChatColor is a class for defining color codes.

Constructors

constructor

new ChatColor(code: string, color?: number): ChatColor
Class ChatColor Constructor.
Parameters
- code: string
  The color code as a string.
- Optionalcolor: number
  The color code as a hexadecimal number. Can be undefined.
Returns ChatColor
- Defined in index.d.ts:1009

Properties

`Static` `Readonly`ALL_COLORS

ALL_COLORS: ChatColor[]

All available color codes excluding the formatting codes.

`Static` `Readonly`AQUA

AQUA: ChatColor

Aqua color code. (b)

`Static` `Readonly`BLACK

BLACK: ChatColor

Black color code. (0)

`Static` `Readonly`BLUE

BLUE: ChatColor

Blue color code. (9)

`Static` `Readonly`BOLD

BOLD: ChatColor

Bold color code. (l)

`Static` `Readonly`DARK_AQUA

DARK_AQUA: ChatColor

Dark aqua color code. (3)

`Static` `Readonly`DARK_BLUE

DARK_BLUE: ChatColor

Dark blue color code. (1)

`Static` `Readonly`DARK_GRAY

DARK_GRAY: ChatColor

Dark gray color code. (8)

`Static` `Readonly`DARK_GREEN

DARK_GREEN: ChatColor

Dark green color code. (2)

`Static` `Readonly`DARK_PURPLE

DARK_PURPLE: ChatColor

Dark purple color code. (5)

`Static` `Readonly`DARK_RED

DARK_RED: ChatColor

Dark red color code. (4)

`Static` `Readonly`GOLD

GOLD: ChatColor

Gold color code. (6)

`Static` `Readonly`GRAY

GRAY: ChatColor

Gray color code. (7)

`Static` `Readonly`GREEN

GREEN: ChatColor

Green color code. (a)

`Static` `Readonly`ITALIC

ITALIC: ChatColor

Italic color code. (o)

`Static` `Readonly`LIGHT_PURPLE

LIGHT_PURPLE: ChatColor

Light purple color code. (d)

`Static` `Readonly`MATERIAL_AMETHYST

MATERIAL_AMETHYST: ChatColor

Material amethyst color code. (u)

`Static` `Readonly`MATERIAL_COPPER

MATERIAL_COPPER: ChatColor

Material copper color code. (n)

`Static` `Readonly`MATERIAL_DIAMOND

MATERIAL_DIAMOND: ChatColor

Material diamond color code. (s)

`Static` `Readonly`MATERIAL_EMERALD

MATERIAL_EMERALD: ChatColor

Material emerald color code. (q)

`Static` `Readonly`MATERIAL_GOLD

MATERIAL_GOLD: ChatColor

Material gold color code. (p)

`Static` `Readonly`MATERIAL_IRON

MATERIAL_IRON: ChatColor

Material iron color code. (i)

`Static` `Readonly`MATERIAL_LAPIS

MATERIAL_LAPIS: ChatColor

Material lapis color code. (t)

`Static` `Readonly`MATERIAL_NETHERITE

MATERIAL_NETHERITE: ChatColor

Material netherite color code. (j)

`Static` `Readonly`MATERIAL_QUARTZ

MATERIAL_QUARTZ: ChatColor

Material quartz color code. (h)

`Static` `Readonly`MATERIAL_REDSTONE

MATERIAL_REDSTONE: ChatColor

Material redstone color code. (m)

`Static` `Readonly`MINECOIN_GOLD

MINECOIN_GOLD: ChatColor

MineCoin gold color code. (g)

`Static` `Readonly`OBFUSCATED

OBFUSCATED: ChatColor

Obfuscated color code. (k)

`Static` `Readonly`RED

RED: ChatColor

Red color code. (c)

`Static` `Readonly`RESET

RESET: ChatColor

Reset color code. (r)

`Static` `Readonly`VALUES

VALUES: ChatColor[]

All available color codes.

`Static` `Readonly`WHITE

WHITE: ChatColor

White color code. (f)

`Static` `Readonly`YELLOW

YELLOW: ChatColor

Yellow color code. (e)

Methods

getBlue

getBlue(): undefined | number
Retrieves the blue value of a color.

Returns undefined | number
The blue value of the color.
- Defined in index.d.ts:1048

getCode

getCode(): string
Retrieves the format code associated with the chat color.

Returns string
The format code of the chat color.
- Defined in index.d.ts:1054

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.
- Defined in index.d.ts:1041

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.
- Defined in index.d.ts:1035

toHex

toHex(): undefined | string
Returns the hexadecimal string representation of the color code

Returns undefined | string
The hexadecimal representation of the color.
- Defined in index.d.ts:1029

toRGB

toRGB(): undefined | number
Returns the color code of the ChatColor instance.

Returns undefined | number
The color code of this ChatColor instance.
- Defined in index.d.ts:1024

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
- Defined in index.d.ts:1019

`Static`findClosestColor

findClosestColor(r: number, g: number, b: number): 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.
- Defined in index.d.ts:1068

`Static`stripColor

stripColor(str: string): 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.
- Defined in index.d.ts:1060

Class ChatColor

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChatColor

Properties

Static ReadonlyALL_COLORS

Static ReadonlyAQUA

Static ReadonlyBLACK

Static ReadonlyBLUE

Static ReadonlyBOLD

Static ReadonlyDARK_AQUA

Static ReadonlyDARK_BLUE

Static ReadonlyDARK_GRAY

Static ReadonlyDARK_GREEN

Static ReadonlyDARK_PURPLE

Static ReadonlyDARK_RED

Static ReadonlyGOLD

Static ReadonlyGRAY

Static ReadonlyGREEN

Static ReadonlyITALIC

Static ReadonlyLIGHT_PURPLE

Static ReadonlyMATERIAL_AMETHYST

Static ReadonlyMATERIAL_COPPER

Static ReadonlyMATERIAL_DIAMOND

Static ReadonlyMATERIAL_EMERALD

Static ReadonlyMATERIAL_GOLD

Static ReadonlyMATERIAL_IRON

Static ReadonlyMATERIAL_LAPIS

Static ReadonlyMATERIAL_NETHERITE

Static ReadonlyMATERIAL_QUARTZ

Static ReadonlyMATERIAL_REDSTONE

Static ReadonlyMINECOIN_GOLD

Static ReadonlyOBFUSCATED

Static ReadonlyRED

Static ReadonlyRESET

Static ReadonlyVALUES

Static ReadonlyWHITE

Static ReadonlyYELLOW

Methods

getBlue

Returns undefined | number

getCode

Returns string

getGreen

Returns undefined | number

getRed

Returns undefined | number

toHex

Returns undefined | string

toRGB

Returns undefined | number

toString

Returns string

StaticfindClosestColor

Parameters

Returns ChatColor

StaticstripColor

Parameters

Returns string

Settings

On This Page

`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

`Static`findClosestColor

`Static`stripColor