Module technology.sola.engine

Package technology.sola.engine.core.event

Enum Class GameLoopState

java.lang.Object

java.lang.Enum<GameLoopState>

technology.sola.engine.core.event.GameLoopState

All Implemented Interfaces:

Serializable, Comparable<GameLoopState>, Constable

public enum GameLoopState
extends Enum<GameLoopState>

The current state of the GameLoop.

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
PAUSE	The game loop is not currently running but can be resumed.
RESUME	The game loop has begun resuming.
STOP	The game loop has begun the process to stop.
STOPPED	The game loop has finished stopping.

Method Summary

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

STOP

public static final GameLoopState STOP

The game loop has begun the process to stop.

STOPPED

public static final GameLoopState STOPPED

The game loop has finished stopping.

PAUSE

public static final GameLoopState PAUSE

The game loop is not currently running but can be resumed.

RESUME

public static final GameLoopState RESUME

The game loop has begun resuming.

Method Details

values

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