org.spongepowered.api

Enum GameState

java.lang.Object

java.lang.Enum<GameState>

org.spongepowered.api.GameState

All Implemented Interfaces:

Serializable, Comparable<GameState>

public enum GameState
extends Enum<GameState>

Top to bottom order of the lifecycle.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTRUCTION During this state, each Plugin instance has been created.
GAME_STOPPED The game has stopped and the JVM will exit.
GAME_STOPPING The game is stopping, all network connections should be closed, all plugins should prepare for shutdown, closing all files.
INITIALIZATION Plugins should finish any work needed to become functional.
LOAD_COMPLETE All plugin initialization and registration should be completed.
POST_INITIALIZATION Plugins have been initialized and should be ready for action.
PRE_INITIALIZATION Plugins are able to access a default logger instance and access configuration files.
SERVER_ABOUT_TO_START The Server instance exists, but worlds have not yet loaded.
SERVER_STARTED The server is fully loaded and ready to accept clients.
SERVER_STARTING The server instance exists and worlds are loaded.
SERVER_STOPPED The server has stopped saving and no players are connected.
SERVER_STOPPING Server is stopping for any reason.

Method Summary

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

CONSTRUCTION

public static final GameState CONSTRUCTION

During this state, each Plugin instance has been created.

PRE_INITIALIZATION

public static final GameState PRE_INITIALIZATION

Plugins are able to access a default logger instance and access configuration files.

INITIALIZATION

public static final GameState INITIALIZATION

Plugins should finish any work needed to become functional. Commands should be registered at this stage.

POST_INITIALIZATION

public static final GameState POST_INITIALIZATION

Plugins have been initialized and should be ready for action. Loggers, configurations, and third party plugin APIs should be prepared for interaction.

LOAD_COMPLETE

public static final GameState LOAD_COMPLETE

All plugin initialization and registration should be completed. The server is now ready to start.

SERVER_ABOUT_TO_START

public static final GameState SERVER_ABOUT_TO_START

The Server instance exists, but worlds have not yet loaded.

SERVER_STARTING

public static final GameState SERVER_STARTING

The server instance exists and worlds are loaded.

SERVER_STARTED

public static final GameState SERVER_STARTED

The server is fully loaded and ready to accept clients. All worlds are loaded and all plugins have been loaded.

SERVER_STOPPING

public static final GameState SERVER_STOPPING

Server is stopping for any reason. This occurs prior to world saving.

SERVER_STOPPED

public static final GameState SERVER_STOPPED

The server has stopped saving and no players are connected. Any changes to the worlds are not saved.

GAME_STOPPING

public static final GameState GAME_STOPPING

The game is stopping, all network connections should be closed, all plugins should prepare for shutdown, closing all files.

Note: In the case that the JVM is terminated, this state may never be reached.

GAME_STOPPED

public static final GameState GAME_STOPPED

The game has stopped and the JVM will exit. Plugins shouldn't expect to receive this event as all files and connections should be terminated.

Note: In the case that the JVM is terminated, this state may never be reached.

Method Detail

values

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

Returns:

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

valueOf

public static GameState valueOf(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:

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

NullPointerException - if the argument is null