Package VASSAL.build.module

Class GameRefresher

java.lang.Object

VASSAL.build.module.GameRefresher

All Implemented Interfaces:

GameComponent

public final class GameRefresher
extends Object
implements GameComponent

GameRefresher Replace all counters in the same game with the current version of the counters defined in the module Note: Counters that are Hidden or Obscured to us cannot be updated.

Constructor Summary

Constructors

Constructor	Description
GameRefresher(GpIdSupport gpIdSupport)

Method Summary

Modifier and Type	Method	Description
void	addTo(AbstractConfigurable parent)
void	execute(Set<String> options, Command command)	This method is used by PredefinedSetup.refresh() to update a PredefinedSetup in a GameModule The default execute() method calls: GameModule.getGameModule().getGameState().getAllPieces() to set the pieces list, this method provides an alternative way to specify which pieces should be refreshed.
List<GamePiece>	getCurrentGameRefresherPieces()
Action	getRefreshAction()
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	isTestMode()
void	log(String message)
void	setup(boolean gameStarting)	Enable Refresh menu item when game is running only.
void	start()

Methods inherited from class java.lang.Object

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

Constructor Details

GameRefresher

public GameRefresher(GpIdSupport gpIdSupport)

Method Details

addTo

public void addTo(AbstractConfigurable parent)

getRefreshAction

public Action getRefreshAction()

isTestMode

public boolean isTestMode()

start

public void start()

log

public void log(String message)

getCurrentGameRefresherPieces

public List<GamePiece> getCurrentGameRefresherPieces()

execute

public void execute(Set<String> options,
Command command)
             throws IllegalBuildException

This method is used by PredefinedSetup.refresh() to update a PredefinedSetup in a GameModule The default execute() method calls: GameModule.getGameModule().getGameState().getAllPieces() to set the pieces list, this method provides an alternative way to specify which pieces should be refreshed.

Parameters:

pieces - - list of pieces to be refreshed, if null defaults to all pieces

pieces - - list of pieces to be refreshed, if null defaults to all pieces

Throws:

IllegalBuildException - - if we get a gpIdChecker error

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

setup

public void setup(boolean gameStarting)

Enable Refresh menu item when game is running only.

Specified by:

setup in interface GameComponent

Parameters:

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