Class EngineConsole.CVARMapping

java.lang.Object

com.blackrook.engine.EngineConsole.CVARMapping

Enclosing class:

EngineConsole

public static class EngineConsole.CVARMapping
extends Object

Mapping for console variables to methods.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this command.
boolean	isArchived()	Gets if this variable is to be archived.
boolean	isGlobal()	Gets if this variable is to stored/read from global.
boolean	isReadOnly()	Gets if this variable is to be archived.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getDescription

public String getDescription()

Gets the description of this command.

Returns:

the description.

isArchived

public boolean isArchived()

Gets if this variable is to be archived.

Returns:

true if so, false if not.

isGlobal

public boolean isGlobal()

Gets if this variable is to stored/read from global.

Returns:

true if so, false if not.

isReadOnly

public boolean isReadOnly()

Gets if this variable is to be archived.

Returns:

true if so, false if not.