Package VASSAL.build.module
Class NewGameIndicator
java.lang.Object
VASSAL.build.module.NewGameIndicator
- All Implemented Interfaces:
GameComponent
,CommandEncoder
public class NewGameIndicator extends Object implements GameComponent, CommandEncoder
Provides information about whether a game was started from File->New Game
or loaded from a saved game
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NewGameIndicator.MarkGameNotNew
-
Constructor Summary
Constructors Constructor Description NewGameIndicator(String command)
-
Method Summary
Modifier and Type Method Description Command
decode(String command)
Translate a String into aCommand
String
encode(Command c)
Translate aCommand
into a StringCommand
getRestoreCommand()
When saving a game, each GameComponent should return aCommand
that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return nullboolean
isNewGame()
void
setup(boolean gameStarting)
Notify the GameComponent that a game has started/ended
-
Constructor Details
-
NewGameIndicator
-
-
Method Details
-
getRestoreCommand
Description copied from interface:GameComponent
When saving a game, each GameComponent should return aCommand
that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null- Specified by:
getRestoreCommand
in interfaceGameComponent
-
isNewGame
public boolean isNewGame()- Returns:
- true if the current game was started from the menu, false if it was loaded from a saved game or logfile.
-
setup
public void setup(boolean gameStarting)Description copied from interface:GameComponent
Notify the GameComponent that a game has started/ended- Specified by:
setup
in interfaceGameComponent
- Parameters:
gameStarting
- if true, a game is starting. If false, then a game is ending
-
decode
Description copied from interface:CommandEncoder
Translate a String into aCommand
- Specified by:
decode
in interfaceCommandEncoder
-
encode
Description copied from interface:CommandEncoder
Translate aCommand
into a String- Specified by:
encode
in interfaceCommandEncoder
-