Package 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
@Deprecated(since="2020-08-06", forRemoval=true) public static class Board.Cleanup extends Object implements GameComponent
Deprecated, for removal: This API element is subject to removal in a future version.
Only used to cleanup Board images, which is now handled automatically by the cache.
Cleans up Boards (by invoking Board.cleanUp()) when a game is closed

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addBoard​(Board b)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Mark this board as needing to be cleaned up when the game is closed
    static Board.Cleanup
    getInstance()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Command
    getRestoreCommand()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setup​(boolean gameStarting)
    Deprecated, for removal: This API element is subject to removal in a future version.
    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 Details

    • init

      public static void init()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getInstance

      public static Board.Cleanup getInstance()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addBoard

      public void addBoard​(Board b)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Mark this board as needing to be cleaned up when the game is closed
      Parameters:
      b - Board

    • getRestoreCommand

      public Command getRestoreCommand()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: GameComponent
      Notify the GameComponent that a game has started/ended
      Specified by:
      setup in interface GameComponent
      Parameters:
      gameStarting - if true, a game is starting. If false, then a game is ending