VASSAL.build.module
Class NewGameIndicator

java.lang.Object
  |
  +--VASSAL.build.module.NewGameIndicator

All Implemented Interfaces:

CommandEncoder, GameComponent

public class NewGameIndicator

extends java.lang.Object

implements GameComponent, CommandEncoder

Provides information about whether a game was started from File->New Game or loaded from a saved game

Inner Class Summary

static class

NewGameIndicator.MarkGameNotNew

Constructor Summary

NewGameIndicator(java.lang.String command)

Method Summary

Command	decode(java.lang.String command) Translate a String into a Command
java.lang.String	encode(Command c) Translate a Command into a String
Command	getRestoreCommand() When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
boolean	isNewGame()
void	setup(boolean gameStarting) Notify the GameComponent that a game has started/ended

Methods inherited from class java.lang.Object

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

Constructor Detail

NewGameIndicator

public NewGameIndicator(java.lang.String command)

Method Detail

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command 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 interface GameComponent

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 interface GameComponent

Following copied from interface: VASSAL.build.module.GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

decode

public Command decode(java.lang.String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public java.lang.String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder