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 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()

    • execute

      public void execute​(boolean testMode, boolean useName)

    • 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