Skip to content

Commit

Permalink
Add more documentation for each color code
Browse files Browse the repository at this point in the history
  • Loading branch information
stirante committed Jan 10, 2025
1 parent d92493b commit a738e7b
Showing 1 changed file with 99 additions and 0 deletions.
99 changes: 99 additions & 0 deletions src/ChatColor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,134 @@
* ChatColor is a class for defining color codes.
*/
export default class ChatColor {
/**
* Black color code. (0)
*/
public static readonly BLACK: ChatColor = new ChatColor('0', 0x000000);
/**
* Dark blue color code. (1)
*/
public static readonly DARK_BLUE: ChatColor = new ChatColor('1', 0x0000aa);
/**
* Dark green color code. (2)
*/
public static readonly DARK_GREEN: ChatColor = new ChatColor('2', 0x00aa00);
/**
* Dark aqua color code. (3)
*/
public static readonly DARK_AQUA: ChatColor = new ChatColor('3', 0x00aaaa);
/**
* Dark red color code. (4)
*/
public static readonly DARK_RED: ChatColor = new ChatColor('4', 0xaa0000);
/**
* Dark purple color code. (5)
*/
public static readonly DARK_PURPLE: ChatColor = new ChatColor('5', 0xaa00aa);
/**
* Gold color code. (6)
*/
public static readonly GOLD: ChatColor = new ChatColor('6', 0xffaa00);
/**
* Gray color code. (7)
*/
public static readonly GRAY: ChatColor = new ChatColor('7', 0xaaaaaa);
/**
* Dark gray color code. (8)
*/
public static readonly DARK_GRAY: ChatColor = new ChatColor('8', 0x555555);
/**
* Blue color code. (9)
*/
public static readonly BLUE: ChatColor = new ChatColor('9', 0x5555ff);
/**
* Green color code. (a)
*/
public static readonly GREEN: ChatColor = new ChatColor('a', 0x55ff55);
/**
* Aqua color code. (b)
*/
public static readonly AQUA: ChatColor = new ChatColor('b', 0x55ffff);
/**
* Red color code. (c)
*/
public static readonly RED: ChatColor = new ChatColor('c', 0xff5555);
/**
* Light purple color code. (d)
*/
public static readonly LIGHT_PURPLE: ChatColor = new ChatColor('d', 0xff55ff);
/**
* Yellow color code. (e)
*/
public static readonly YELLOW: ChatColor = new ChatColor('e', 0xffff55);
/**
* White color code. (f)
*/
public static readonly WHITE: ChatColor = new ChatColor('f', 0xffffff);
/**
* MineCoin gold color code. (g)
*/
public static readonly MINECOIN_GOLD: ChatColor = new ChatColor('g', 0xded605);
/**
* Material quartz color code. (h)
*/
public static readonly MATERIAL_QUARTZ: ChatColor = new ChatColor('h', 0xe3d4d1);
/**
* Material iron color code. (i)
*/
public static readonly MATERIAL_IRON: ChatColor = new ChatColor('i', 0xcecaca);
/**
* Material netherite color code. (j)
*/
public static readonly MATERIAL_NETHERITE: ChatColor = new ChatColor('j', 0x443a3b);
/**
* Material redstone color code. (m)
*/
public static readonly MATERIAL_REDSTONE: ChatColor = new ChatColor('m', 0x971607);
/**
* Material copper color code. (n)
*/
public static readonly MATERIAL_COPPER: ChatColor = new ChatColor('n', 0xb4684d);
/**
* Material gold color code. (p)
*/
public static readonly MATERIAL_GOLD: ChatColor = new ChatColor('p', 0xdeb12d);
/**
* Material emerald color code. (q)
*/
public static readonly MATERIAL_EMERALD: ChatColor = new ChatColor('q', 0x11a036);
/**
* Material diamond color code. (s)
*/
public static readonly MATERIAL_DIAMOND: ChatColor = new ChatColor('s', 0x2cbaa8);
/**
* Material lapis color code. (t)
*/
public static readonly MATERIAL_LAPIS: ChatColor = new ChatColor('t', 0x21497b);
/**
* Material amethyst color code. (u)
*/
public static readonly MATERIAL_AMETHYST: ChatColor = new ChatColor('u', 0x9a5cc6);
/**
* Obfuscated color code. (k)
*/
public static readonly OBFUSCATED: ChatColor = new ChatColor('k');
/**
* Bold color code. (l)
*/
public static readonly BOLD: ChatColor = new ChatColor('l');
/**
* Italic color code. (o)
*/
public static readonly ITALIC: ChatColor = new ChatColor('o');
/**
* Reset color code. (r)
*/
public static readonly RESET: ChatColor = new ChatColor('r');

/**
* All available color codes.
*/
public static readonly VALUES: ChatColor[] = [
ChatColor.BLACK,
ChatColor.DARK_BLUE,
Expand Down Expand Up @@ -68,6 +164,9 @@ export default class ChatColor {
ChatColor.RESET
];

/**
* All available color codes excluding the formatting codes.
*/
public static readonly ALL_COLORS: ChatColor[] = [
ChatColor.BLACK,
ChatColor.DARK_BLUE,
Expand Down

0 comments on commit a738e7b

Please sign in to comment.