Package com.planet_ink.coffee_mud.Locales.interfaces

Enum Room.VariationCode

java.lang.Object

java.lang.Enum<Room.VariationCode>

com.planet_ink.coffee_mud.Locales.interfaces.Room.VariationCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Room.VariationCode>

Enclosing interface:

Room

public static enum Room.VariationCode
extends java.lang.Enum<Room.VariationCode>

Room titles and descriptions can be coded with xml/html-like tags that denote different parts that are shown or hidden depending on the weather, the season, the time of day, or even whether the player has been to the room before. This enumerator is used to define those tags and give the engine clues on how to quickly interpret them when building dynamic titles and descriptions.

See Also:

Environmental.setDisplayText(String), Environmental.setDescription(String)

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLIZZARD
CLEAR
CLIMBING
CLOUDY
COLD
CRAWLING
DAWN
DAY
DAYTIME
DROUGHT
DUSK
DUSTSTORM
ELSE
FALL
FALLING
FLYING
FOG
HAIL
HEATWAVE
HIDDEN
INVISIBLE
MASK
NIGHT
NIGHTTIME
RAIN
SITTING
SLEET
SNOW
SPRING
SUMMER
SWIMMING
THUNDERSTORM
VARIES
VISITED
WINDY
WINTER

Field Summary

Fields

Modifier and Type	Field	Description
char	c
java.lang.String	closeTag
int	num
java.lang.String	openTag

Method Summary

Modifier and Type	Method	Description
static Room.VariationCode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Room.VariationCode[]	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

SUMMER

public static final Room.VariationCode SUMMER

SPRING

public static final Room.VariationCode SPRING

WINTER

public static final Room.VariationCode WINTER

FALL

public static final Room.VariationCode FALL

DAY

public static final Room.VariationCode DAY

DAYTIME

public static final Room.VariationCode DAYTIME

NIGHT

public static final Room.VariationCode NIGHT

NIGHTTIME

public static final Room.VariationCode NIGHTTIME

DAWN

public static final Room.VariationCode DAWN

DUSK

public static final Room.VariationCode DUSK

RAIN

public static final Room.VariationCode RAIN

SLEET

public static final Room.VariationCode SLEET

SNOW

public static final Room.VariationCode SNOW

CLEAR

public static final Room.VariationCode CLEAR

HEATWAVE

public static final Room.VariationCode HEATWAVE

FOG

public static final Room.VariationCode FOG

THUNDERSTORM

public static final Room.VariationCode THUNDERSTORM

BLIZZARD

public static final Room.VariationCode BLIZZARD

WINDY

public static final Room.VariationCode WINDY

DROUGHT

public static final Room.VariationCode DROUGHT

DUSTSTORM

public static final Room.VariationCode DUSTSTORM

COLD

public static final Room.VariationCode COLD

HAIL

public static final Room.VariationCode HAIL

CLOUDY

public static final Room.VariationCode CLOUDY

SWIMMING

public static final Room.VariationCode SWIMMING

FLYING

public static final Room.VariationCode FLYING

CRAWLING

public static final Room.VariationCode CRAWLING

SITTING

public static final Room.VariationCode SITTING

FALLING

public static final Room.VariationCode FALLING

CLIMBING

public static final Room.VariationCode CLIMBING

INVISIBLE

public static final Room.VariationCode INVISIBLE

HIDDEN

public static final Room.VariationCode HIDDEN

MASK

public static final Room.VariationCode MASK

VISITED

public static final Room.VariationCode VISITED

ELSE

public static final Room.VariationCode ELSE

VARIES

public static final Room.VariationCode VARIES

Field Detail

c

public final char c

num

public final int num

openTag

public final java.lang.String openTag

closeTag

public final java.lang.String closeTag

Method Detail

values

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

Returns:

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

valueOf

public static Room.VariationCode 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