java.lang.Object

VASSAL.build.module.GameState

All Implemented Interfaces:: CommandEncoder

public class GameState
extends Object
implements CommandEncoder

The GameState represents the state of the game currently being played. Only one game can be open at once.

See Also:: GameModule.getGameState()

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GameState.SetupCommand

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BEGIN_SAVE`
`protected Action`	`closeGame`
`static String`	`END_SAVE`
`protected List<GameComponent>`	`gameComponents`
`protected String`	`lastSave`
`protected File`	`lastSaveFile`
`protected String`	`loadComments`
`protected Action`	`loadGame`
`protected Action`	`newGame`
`protected Map<String,GamePiece>`	`pieces`
`protected DirectoryConfigurer`	`savedGameDirectoryPreference`
`static String`	`SAVEFILE_ZIP_ENTRY`
`protected Action`	`saveGame`
`protected Action`	`saveGameAs`
`protected List<GameSetupStep>`	`setupSteps`

Constructor Summary

Constructors

Constructor Description

GameState()

Method Summary

Modifier and Type	Method	Description
`void`	`addGameComponent(GameComponent theComponent)`	Add a `GameComponent` to the list of objects that will be notified when a game is started/ended
`void`	`addGameSetupStep(GameSetupStep step)`	Add a `GameSetupStep`
`void`	`addPiece(GamePiece p)`	Add a `GamePiece` to the current game.
`void`	`addTo(GameModule mod)`	Expects to be added to a GameModule.
`protected boolean`	`checkForOldSaveFile(File f)`
`Command`	`decode(String theCommand)`	A GameState recognizes instances of `GameState.SetupCommand`
`Command`	`decodeSavedGame(File saveFile)`	Read a saved game and translate it into a Command.
`Command`	`decodeSavedGame(InputStream in)`
`String`	`encode(Command c)`	A GameState recognizes instances of `GameState.SetupCommand`
`Collection<GamePiece>`	`getAllPieces()`
`Collection<GameComponent>`	`getGameComponents()`
`String`	`getNewPieceId()`
`GamePiece`	`getPieceForId(String id)`
`Enumeration<GamePiece>`	`getPieces()`	Deprecated. Use `getAllPieces()` instead.
`Command`	`getRestoreCommand()`	Return a `Command` that, when executed, will restore the game to its current state.
`Command`	`getRestorePiecesCommand()`
`DirectoryConfigurer`	`getSavedGameDirectoryPreference()`
`Iterator<GameSetupStep>`	`getUnfinishedSetupSteps()`
`boolean`	`isGameStarted()`	Return true if a game is currently in progress
`boolean`	`isModified()`
`boolean`	`isUpdating()`
`void`	`loadContinuation(File f)`
`void`	`loadGame()`	Read the game from a savefile.
`void`	`loadGameInBackground(File f)`
`void`	`loadGameInBackground(String shortName, InputStream in)`
`void`	`removeGameComponent(GameComponent theComponent)`	Remove a `GameComponent` from the list of objects that will be notified when a game is started/ended
`void`	`removeGameSetupStep(GameSetupStep step)`	Remove a `GameSetupStep`
`void`	`removePiece(String id)`	Remove a `GamePiece` from the current game
`void`	`saveGame()`	Saves the game to an existing file, or prompts for a new one.
`void`	`saveGame(File f)`
`void`	`saveGameAs()`	Prompts the user for a file into which to save the game
`protected String`	`saveString()`
`void`	`setModified(boolean modified)`
`void`	`setup(boolean gameStarting)`	Start/end a game.
`void`	`setup(boolean gameStarting, boolean gameUpdating)`	Start a game for updating (via editor).
`void`	`updateDone()`	Indicated game update is completed and game is saved.

Methods inherited from class java.lang.Object

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

Field Details
- pieces
  
  protected Map<String,GamePiece> pieces
- gameComponents
  
  protected List<GameComponent> gameComponents
- setupSteps
  
  protected List<GameSetupStep> setupSteps
- loadGame
  
  protected Action loadGame
- saveGame
  
  protected Action saveGame
- saveGameAs
  
  protected Action saveGameAs
- newGame
  
  protected Action newGame
- closeGame
  
  protected Action closeGame
- lastSave
  
  protected String lastSave
- lastSaveFile
  
  protected File lastSaveFile
- savedGameDirectoryPreference
  
  protected DirectoryConfigurer savedGameDirectoryPreference
- loadComments
  
  protected String loadComments
- SAVEFILE_ZIP_ENTRY
  
  public static final String SAVEFILE_ZIP_ENTRY
  
  See Also:
  
  Constant Field Values
- BEGIN_SAVE
  
  public static final String BEGIN_SAVE
  
  See Also:
  
  Constant Field Values
- END_SAVE
  
  public static final String END_SAVE
  
  See Also:
  
  Constant Field Values
Constructor Details
- GameState
  
  public GameState()
Method Details
- addTo
  
  public void addTo(GameModule mod)
  
  Expects to be added to a GameModule. Adds New, Load, Close, and Save entries to the File menu of the controls window
- isModified
  
  public boolean isModified()
  
  Returns:
  
  true if the game state is different from when it was last saved
- addGameComponent
  
  public void addGameComponent(GameComponent theComponent)
  
  Add a GameComponent to the list of objects that will be notified when a game is started/ended
- removeGameComponent
  
  public void removeGameComponent(GameComponent theComponent)
  
  Remove a GameComponent from the list of objects that will be notified when a game is started/ended
- getGameComponents
  
  public Collection<GameComponent> getGameComponents()
  
  Returns:
  
  a Collection of all GameComponent objects that have been added to this GameState
- addGameSetupStep
  
  public void addGameSetupStep(GameSetupStep step)
  
  Add a GameSetupStep
- removeGameSetupStep
  
  public void removeGameSetupStep(GameSetupStep step)
  
  Remove a GameSetupStep
- getUnfinishedSetupSteps
  
  public Iterator<GameSetupStep> getUnfinishedSetupSteps()
  
  Returns:
  
  an iterator of all GameSetupSteps that are not yet finished
- setup
  
  public void setup(boolean gameStarting, boolean gameUpdating)
  
  Start a game for updating (via editor). NOTE: This method is not for use in custom code.
- updateDone
  
  public void updateDone()
  
  Indicated game update is completed and game is saved.
- isUpdating
  
  public boolean isUpdating()
- setup
  
  public void setup(boolean gameStarting)
  
  Start/end a game. Prompt to save if the game state has been modified since last save. Invoke GameComponent.setup(boolean) on all registered GameComponent objects.
- isGameStarted
  
  public boolean isGameStarted()
  
  Return true if a game is currently in progress
- loadGame
  
  public void loadGame()
  
  Read the game from a savefile. The contents of the file is sent to GameModule.decode(java.lang.String) and translated into a Command, which is then executed. The command read from the file should be that returned by getRestoreCommand().
- saveString
  
  protected String saveString()
- checkForOldSaveFile
  
  protected boolean checkForOldSaveFile(File f)
- saveGame
  
  public void saveGame()
  
  Saves the game to an existing file, or prompts for a new one.
- saveGameAs
  
  public void saveGameAs()
  
  Prompts the user for a file into which to save the game
- setModified
  
  public void setModified(boolean modified)
- addPiece
  
  public void addPiece(GamePiece p)
  
  Add a GamePiece to the current game. The GameState keeps track of all GamePieces in the system, regardless of which Map they belong to (if any)
- getPieceForId
  
  public GamePiece getPieceForId(String id)
  
  Returns:
  
  the GamePiece in the current game with the given id
- removePiece
  
  public void removePiece(String id)
  
  Remove a GamePiece from the current game
- getNewPieceId
  
  public String getNewPieceId()
  
  Returns:
  
  a String identifier guaranteed to be different from the id of all GamePieces in the game
  
  See Also:
  
  GamePiece.getId()
- loadContinuation
  
  public void loadContinuation(File f) throws IOException
  
  Throws:
  
  IOException
- getPieces
  
  @Deprecated public Enumeration<GamePiece> getPieces()
  
  Deprecated.
  Use getAllPieces() instead.
  
  Returns:
  
  an Enumeration of all GamePieces in the game
- getAllPieces
  
  public Collection<GamePiece> getAllPieces()
  
  Returns:
  
  a Collection of all GamePieces in the game
- getRestoreCommand
  
  public Command getRestoreCommand()
  
  Return a Command that, when executed, will restore the game to its current state. Invokes GameComponent.getRestoreCommand() on each registered GameComponent
- encode
  
  public String encode(Command c)
  
  A GameState recognizes instances of GameState.SetupCommand
  
  Specified by:
  
  encode in interface CommandEncoder
- decode
  
  public Command decode(String theCommand)
  
  A GameState recognizes instances of GameState.SetupCommand
  
  Specified by:
  
  decode in interface CommandEncoder
- saveGame
  
  public void saveGame(File f) throws IOException
  
  Throws:
  
  IOException
- loadGameInBackground
  
  public void loadGameInBackground(File f)
- loadGameInBackground
  
  public void loadGameInBackground(String shortName, InputStream in)
- getRestorePiecesCommand
  
  public Command getRestorePiecesCommand()
  
  Returns:
  
  a Command that, when executed, will add all pieces currently in the game. Used when saving a game.
- decodeSavedGame
  
  public Command decodeSavedGame(File saveFile) throws IOException
  
  Read a saved game and translate it into a Command. Executing the command will load the saved game.
  
  Parameters:
  
  fileName -
  
  Returns:
  
  Throws:
  
  IOException
- decodeSavedGame
  
  public Command decodeSavedGame(InputStream in) throws IOException
  
  Throws:
  
  IOException
- getSavedGameDirectoryPreference
  
  public DirectoryConfigurer getSavedGameDirectoryPreference()

Class GameState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details