Package org.bukkit

Enum ChatColor

java.lang.Object

java.lang.Enum<ChatColor>

org.bukkit.ChatColor

public enum ChatColor
extends java.lang.Enum<ChatColor>

All supported color values for chat

Enum Constant Summary

Enum Constants

Enum Constant	Description
AQUA	Represents aqua
BLACK	Represents black
BLUE	Represents blue
BOLD	Makes the text bold.
DARK_AQUA	Represents dark blue (aqua)
DARK_BLUE	Represents dark blue
DARK_GRAY	Represents dark gray
DARK_GREEN	Represents dark green
DARK_PURPLE	Represents dark purple
DARK_RED	Represents dark red
GOLD	Represents gold
GRAY	Represents gray
GREEN	Represents green
ITALIC	Makes the text italic.
LIGHT_PURPLE	Represents light purple
MAGIC	Represents magical characters that change around randomly
RED	Represents red
RESET	Resets all previous chat colors or formats.
STRIKETHROUGH	Makes a line appear through the text.
UNDERLINE	Makes the text appear underlined.
WHITE	Represents white
YELLOW	Represents yellow

Field Summary

Fields

Modifier and Type	Field	Description
static char	COLOR_CHAR	The special character which prefixes all chat colour codes.

Method Summary

Modifier and Type	Method	Description
static ChatColor	getByChar(char code)	Gets the color represented by the specified color code
static ChatColor	getByChar(java.lang.String code)	Gets the color represented by the specified color code
char	getChar()	Gets the char value associated with this color
static java.lang.String	getLastColors(java.lang.String input)	Gets the ChatColors used at the end of the given input string.
boolean	isColor()	Checks if this code is a color code as opposed to a format code.
boolean	isFormat()	Checks if this code is a format code as opposed to a color code.
static java.lang.String	stripColor(java.lang.String input)	Strips the given message of all color codes
java.lang.String	toString()
static java.lang.String	translateAlternateColorCodes(char altColorChar, java.lang.String textToTranslate)	Translates a string using an alternate color code character into a string that uses the internal ChatColor.COLOR_CODE color code character.
static ChatColor	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ChatColor[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLACK

public static final ChatColor BLACK

Represents black

DARK_BLUE

public static final ChatColor DARK_BLUE

Represents dark blue

DARK_GREEN

public static final ChatColor DARK_GREEN

Represents dark green

DARK_AQUA

public static final ChatColor DARK_AQUA

Represents dark blue (aqua)

DARK_RED

public static final ChatColor DARK_RED

Represents dark red

DARK_PURPLE

public static final ChatColor DARK_PURPLE

Represents dark purple

GOLD

public static final ChatColor GOLD

Represents gold

GRAY

public static final ChatColor GRAY

Represents gray

DARK_GRAY

public static final ChatColor DARK_GRAY

Represents dark gray

BLUE

public static final ChatColor BLUE

Represents blue

GREEN

public static final ChatColor GREEN

Represents green

AQUA

public static final ChatColor AQUA

Represents aqua

RED

public static final ChatColor RED

Represents red

LIGHT_PURPLE

public static final ChatColor LIGHT_PURPLE

Represents light purple

YELLOW

public static final ChatColor YELLOW

Represents yellow

WHITE

public static final ChatColor WHITE

Represents white

MAGIC

public static final ChatColor MAGIC

Represents magical characters that change around randomly

BOLD

public static final ChatColor BOLD

Makes the text bold.

STRIKETHROUGH

public static final ChatColor STRIKETHROUGH

Makes a line appear through the text.

UNDERLINE

public static final ChatColor UNDERLINE

Makes the text appear underlined.

ITALIC

public static final ChatColor ITALIC

Makes the text italic.

RESET

public static final ChatColor RESET

Resets all previous chat colors or formats.

Field Detail

COLOR_CHAR

public static final char COLOR_CHAR

The special character which prefixes all chat colour codes. Use this if you need to dynamically convert colour codes from your custom format.

See Also:

Constant Field Values

Method Detail

values

public static ChatColor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChatColor c : ChatColor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ChatColor valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getChar

public char getChar()

Gets the char value associated with this color

Returns:

A char value of this color code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ChatColor>

isFormat

public boolean isFormat()

Checks if this code is a format code as opposed to a color code.

Returns:

whether this ChatColor is a format code

isColor

public boolean isColor()

Checks if this code is a color code as opposed to a format code.

Returns:

whether this ChatColor is a color code

getByChar

public static ChatColor getByChar(char code)

Gets the color represented by the specified color code

Parameters:

code - Code to check

Returns:

Associative ChatColor with the given code, or null if it doesn't exist

getByChar

public static ChatColor getByChar(java.lang.String code)

Gets the color represented by the specified color code

Parameters:

code - Code to check

Returns:

Associative ChatColor with the given code, or null if it doesn't exist

stripColor

public static java.lang.String stripColor(java.lang.String input)

Strips the given message of all color codes

Parameters:

input - String to strip of color

Returns:

A copy of the input string, without any coloring

translateAlternateColorCodes

public static java.lang.String translateAlternateColorCodes(char altColorChar,
                                                            java.lang.String textToTranslate)

Translates a string using an alternate color code character into a string that uses the internal ChatColor.COLOR_CODE color code character. The alternate color code character will only be replaced if it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.

Parameters:

altColorChar - The alternate color code character to replace. Ex: &

textToTranslate - Text containing the alternate color code character.

Returns:

Text containing the ChatColor.COLOR_CODE color code character.

getLastColors

public static java.lang.String getLastColors(java.lang.String input)

Gets the ChatColors used at the end of the given input string.

Parameters:

input - Input string to retrieve the colors from.

Returns:

Any remaining ChatColors to pass onto the next line.