Package tech.underoaks.coldcase.state.updates

Enum Class UpdateTypes

java.lang.Object

java.lang.Enum<UpdateTypes>

tech.underoaks.coldcase.state.updates.UpdateTypes

All Implemented Interfaces:

Serializable, Comparable<UpdateTypes>, Constable

public enum UpdateTypes
extends Enum<UpdateTypes>

Enum representing the types of GameStateUpdates.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUDIO_EFFECT	Update involving audio effects (e.g.
MAP_MODIFICATION	Update involving changes to the map structure (e.g.
VISUAL_EFFECT	Update involving visual effects (e.g.

Method Summary

Modifier and Type	Method	Description
boolean	hasConsequences()	Checks whether this UpdateTypes has consequences or not
static UpdateTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UpdateTypes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MAP_MODIFICATION

public static final UpdateTypes MAP_MODIFICATION

Update involving changes to the map structure (e.g. moving an object)

VISUAL_EFFECT

public static final UpdateTypes VISUAL_EFFECT

Update involving visual effects (e.g. particle effects, animations)

AUDIO_EFFECT

public static final UpdateTypes AUDIO_EFFECT

Update involving audio effects (e.g. sound effects)

Method Details

values

public static UpdateTypes[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UpdateTypes valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

hasConsequences

public boolean hasConsequences()

Checks whether this UpdateTypes has consequences or not

Returns:

true if it requires consecutive update calls; false otherwise