Package dev.itsharshxd.zentrix.api.game

Enum Class ZentrixGame.GameState

java.lang.Object

java.lang.Enum<ZentrixGame.GameState>

dev.itsharshxd.zentrix.api.game.ZentrixGame.GameState

All Implemented Interfaces:

Serializable, Comparable<ZentrixGame.GameState>, Constable

Enclosing interface:

ZentrixGame

public static enum ZentrixGame.GameState
extends Enum<ZentrixGame.GameState>

Represents the possible states of a Zentrix game.

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
ENDING	Game has ended and winner is being announced.
PLAYING	Game is actively being played.
RESTARTING	Game is restarting/cleaning up.
STARTING	Game has enough players and countdown has started.
WAITING	Game is waiting for players to join.

Method Summary

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

WAITING

public static final ZentrixGame.GameState WAITING

Game is waiting for players to join. Players can join during this state.

STARTING

public static final ZentrixGame.GameState STARTING

Game has enough players and countdown has started. Players can still join during this state.

PLAYING

public static final ZentrixGame.GameState PLAYING

Game is actively being played. Players cannot join (only spectate).

ENDING

public static final ZentrixGame.GameState ENDING

Game has ended and winner is being announced. Transitioning to cleanup.

RESTARTING

public static final ZentrixGame.GameState RESTARTING

Game is restarting/cleaning up. Arena is being reset.

Method Details

values

public static ZentrixGame.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 ZentrixGame.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