com.planet_ink.coffee_mud.Libraries.interfaces
Enum ColorLibrary.SpecialColor

java.lang.Object
  extended by java.lang.Enum<ColorLibrary.SpecialColor>
      extended by com.planet_ink.coffee_mud.Libraries.interfaces.ColorLibrary.SpecialColor
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ColorLibrary.SpecialColor>
Enclosing interface:
ColorLibrary

public static enum ColorLibrary.SpecialColor
extends java.lang.Enum<ColorLibrary.SpecialColor>

The special color codes are named color codes which are usually renameable by the user to other basic colors.


Enum Constant Summary
CHANNEL
           
CHANNELFORE
           
DIRECTION
           
DOORDESC
           
EMOTE
           
FIGHT
           
FIGHT_YOU
           
HIGHLIGHT
           
HITPOINTS
           
IMPORTANT1
           
IMPORTANT2
           
IMPORTANT3
           
ITEM
           
MANA
           
MOB
           
MOVES
           
NORMAL
           
ROOMDESC
           
ROOMTITLE
           
SPELL
           
TALK
           
TELL
           
UNEXPDIRECTION
           
UNEXPDOORDESC
           
WEATHER
           
YOU_FIGHT
           
 
Method Summary
 char getCodeChar()
          Returns the ^ color code
 java.lang.String getCodeString()
          Returns the name with _ replaced by -
 java.lang.String getEscapeCode()
          Returns the FULL ^ color code
static ColorLibrary.SpecialColor valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ColorLibrary.SpecialColor[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

YOU_FIGHT

public static final ColorLibrary.SpecialColor YOU_FIGHT

FIGHT_YOU

public static final ColorLibrary.SpecialColor FIGHT_YOU

FIGHT

public static final ColorLibrary.SpecialColor FIGHT

SPELL

public static final ColorLibrary.SpecialColor SPELL

EMOTE

public static final ColorLibrary.SpecialColor EMOTE

TALK

public static final ColorLibrary.SpecialColor TALK

TELL

public static final ColorLibrary.SpecialColor TELL

CHANNEL

public static final ColorLibrary.SpecialColor CHANNEL

CHANNELFORE

public static final ColorLibrary.SpecialColor CHANNELFORE

IMPORTANT1

public static final ColorLibrary.SpecialColor IMPORTANT1

IMPORTANT2

public static final ColorLibrary.SpecialColor IMPORTANT2

IMPORTANT3

public static final ColorLibrary.SpecialColor IMPORTANT3

ROOMTITLE

public static final ColorLibrary.SpecialColor ROOMTITLE

ROOMDESC

public static final ColorLibrary.SpecialColor ROOMDESC

DIRECTION

public static final ColorLibrary.SpecialColor DIRECTION

DOORDESC

public static final ColorLibrary.SpecialColor DOORDESC

ITEM

public static final ColorLibrary.SpecialColor ITEM

MOB

public static final ColorLibrary.SpecialColor MOB

HITPOINTS

public static final ColorLibrary.SpecialColor HITPOINTS

MANA

public static final ColorLibrary.SpecialColor MANA

MOVES

public static final ColorLibrary.SpecialColor MOVES

NORMAL

public static final ColorLibrary.SpecialColor NORMAL

HIGHLIGHT

public static final ColorLibrary.SpecialColor HIGHLIGHT

UNEXPDIRECTION

public static final ColorLibrary.SpecialColor UNEXPDIRECTION

UNEXPDOORDESC

public static final ColorLibrary.SpecialColor UNEXPDOORDESC

WEATHER

public static final ColorLibrary.SpecialColor WEATHER
Method Detail

values

public static ColorLibrary.SpecialColor[] 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 (ColorLibrary.SpecialColor c : ColorLibrary.SpecialColor.values())
    System.out.println(c);

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

valueOf

public static ColorLibrary.SpecialColor 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

getCodeChar

public final char getCodeChar()
Returns the ^ color code

Returns:
the ^ color code

getEscapeCode

public final java.lang.String getEscapeCode()
Returns the FULL ^ color code

Returns:
the FULL ^ color code

getCodeString

public final java.lang.String getCodeString()
Returns the name with _ replaced by -

Returns:
the name with _ replaced by -