Package dev.itsharshxd.zentrix.api.broadcast

Enum Class GameState

java.lang.Object

java.lang.Enum<GameState>

dev.itsharshxd.zentrix.api.broadcast.GameState

All Implemented Interfaces:

Serializable, Comparable<GameState>, Constable

public enum GameState
extends Enum<GameState>

Enum representing game states for broadcast filtering.

Since:

1.1.0

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
LOBBY	The lobby state before any game is active.
PLAYING	The playing state during an active game.
WAITING	The waiting state while players are joining.

Method Summary

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

LOBBY

public static final GameState LOBBY

The lobby state before any game is active.

WAITING

public static final GameState WAITING

The waiting state while players are joining.

PLAYING

public static final GameState PLAYING

The playing state during an active game.

Method Details

values

public static GameState[] 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 GameState 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