com.fs.starfarer.api

Enum GameState

java.lang.Object

java.lang.Enum<GameState>

com.fs.starfarer.api.GameState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GameState>

public enum GameState
extends java.lang.Enum<GameState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAMPAIGN
COMBAT
TITLE

Method Summary

Modifier and Type	Method and Description
static GameState	valueOf(java.lang.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

TITLE

public static final GameState TITLE

CAMPAIGN

public static final GameState CAMPAIGN

COMBAT

public static final GameState COMBAT

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null