Package name.moore.kevin.ze.game

Enum gameConfig.keys

java.lang.Object

java.lang.Enum<gameConfig.keys>

name.moore.kevin.ze.game.gameConfig.keys

All Implemented Interfaces:

Serializable, Comparable<gameConfig.keys>, java.lang.constant.Constable

Enclosing class:

gameConfig

public static enum gameConfig.keys
extends Enum<gameConfig.keys>

Enum all the allowed settings values in the gameConfig file or provided on the command line and associate defaults. All of these keys will be added to the game application settings.

See Also:

AppSettings

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
ECSSTRUCTUREOUTPUTF	Output a diagnostic of the entities and components structure.
GAMES	The base location of XML game files.
JHEIGHT
JWIDTH	Screen size, we use 'J' because JME's width height already have meaning.
LAST
MAPS	The base location of XML stellar map files.
REMOTE	remoteState port to use.
REMOTEPORT
SCRIPT	The location of a script file - set from command line only.
SPECIFICATIONS	The location of XML specification files, all files in this directory will be loaded.
STATEMACHINEOUTPUTF	Output diagnostic file of the state machine implemented in zodiac.java.
UPDATETRACE	Control output of a trace logging message from update() - this can generate a substantial amount of log messages if enabled.

Field Summary

Fields

Modifier and Type	Field	Description
private String	def	Default value for a key - the class of which depends on which constructor we used.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	keys(String def)

Method Summary

Modifier and Type	Method	Description
static Properties	getAllDefaults()	Properties are always stored as a String.
private String	getDefault()
static gameConfig.keys	valueOf(String name)	Returns the enum constant of this type with the specified name.
static gameConfig.keys[]	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, 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

SPECIFICATIONS

public static final gameConfig.keys SPECIFICATIONS

The location of XML specification files, all files in this directory will be loaded.

Element <entry key="specifications">...</entry>, defaults to /src/main/resources/specifications

GAMES

public static final gameConfig.keys GAMES

The base location of XML game files.

Element <entry key="games">...</entry>, defaults to /src/main/resources/games

MAPS

public static final gameConfig.keys MAPS

The base location of XML stellar map files.

Element <entry key="maps">...</entry>, defaults to /src/main/resources/maps

SCRIPT

public static final gameConfig.keys SCRIPT

The location of a script file - set from command line only.

defaults to "" ie no script to execute.

REMOTE

public static final gameConfig.keys REMOTE

remoteState port to use. Need to explicitly switch on with remote=true

REMOTEPORT

public static final gameConfig.keys REMOTEPORT

STATEMACHINEOUTPUTF

public static final gameConfig.keys STATEMACHINEOUTPUTF

Output diagnostic file of the state machine implemented in zodiac.java.

Defaults to /src/site/dia/zodiacstatemachine.dot where it is used in site documentation building.

Additionally requires log4j log4j.logger.name.moore.kevin.ze.game.states.appFSM=TRACE

ECSSTRUCTUREOUTPUTF

public static final gameConfig.keys ECSSTRUCTUREOUTPUTF

Output a diagnostic of the entities and components structure.

UPDATETRACE

public static final gameConfig.keys UPDATETRACE

Control output of a trace logging message from update() - this can generate a substantial amount of log messages if enabled.

JWIDTH

public static final gameConfig.keys JWIDTH

Screen size, we use 'J' because JME's width height already have meaning.

JHEIGHT

public static final gameConfig.keys JHEIGHT

LAST

public static final gameConfig.keys LAST

Field Details

def

private final String def

Default value for a key - the class of which depends on which constructor we used.

Constructor Details

keys

private keys(String def)

Method Details

values

public static gameConfig.keys[] values()

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

Returns:

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

valueOf

public static gameConfig.keys 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

getDefault

private String getDefault()

getAllDefaults

public static Properties getAllDefaults()

Properties are always stored as a String.

Returns: