VASSAL.build.module.map.boardPicker
Class Board.Cleanup

java.lang.Object
  |
  +--VASSAL.build.module.map.boardPicker.Board.Cleanup

All Implemented Interfaces:

GameComponent

Enclosing class:

Board

public static class Board.Cleanup

extends java.lang.Object

implements GameComponent

Cleans up Boards (by invoking Board.cleanUp()) when a game is closed

Method Summary

void	addBoard(Board b) Mark this board as needing to be cleaned up when the game is closed
static Board.Cleanup	getInstance()
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
static void	init()
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

Method Detail

init

public static void init()

getInstance

public static Board.Cleanup getInstance()

addBoard

public void addBoard(Board b)

Mark this board as needing to be cleaned up when the game is closed

Parameters:

b -

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)

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