Package com.epicbot.api.os.model.game

Enum Class GameState

java.lang.Object

java.lang.Enum<GameState>

com.epicbot.api.os.model.game.GameState

All Implemented Interfaces:

GameState, Serializable, Comparable<GameState>, Constable

public enum GameState
extends Enum<GameState>
implements GameState

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
CONNECTION_LOST	Connection to the server was lost.
HOPPING	A world hop is taking place.
LOADING	The game is being loaded.
LOGGED_IN	The user has successfully logged in.
LOGGING_IN	There is a player logging in.
LOGIN_SCREEN	The client is at the login screen.
LOGIN_SCREEN_AUTHENTICATOR	The client is at the login screen entering authenticator code.
STARTING	The client is starting.
UNKNOWN	Unknown game state.

Method Summary

Modifier and Type	Method	Description
int	getState()
static GameState	of(int state)
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

Methods inherited from interface com.epicbot.api.shared.model.game.GameState

is

Enum Constant Details

UNKNOWN

public static final GameState UNKNOWN

Unknown game state.

STARTING

public static final GameState STARTING

The client is starting.

LOGIN_SCREEN

public static final GameState LOGIN_SCREEN

The client is at the login screen.

LOGIN_SCREEN_AUTHENTICATOR

public static final GameState LOGIN_SCREEN_AUTHENTICATOR

The client is at the login screen entering authenticator code.

LOGGING_IN

public static final GameState LOGGING_IN

There is a player logging in.

LOADING

public static final GameState LOADING

The game is being loaded.

LOGGED_IN

public static final GameState LOGGED_IN

The user has successfully logged in.

CONNECTION_LOST

public static final GameState CONNECTION_LOST

Connection to the server was lost.

HOPPING

public static final GameState HOPPING

A world hop is taking place.

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

getState

public int getState()

Specified by:

getState in interface GameState

of

public static GameState of(int state)