games.strategy.engine.framework
Interface IGame

All Known Implementing Classes:
ClientGame, ServerGame

public interface IGame

Represents a running game.

Allows access to the games communication interfaces, and to listen to the current game step.

Author:
Sean Bridges

Field Summary
static RemoteName GAME_MODIFICATION_CHANNEL
           
 
Method Summary
 void addChange(Change aChange)
          Should not be called outside of engine code.
 void addDisplay(IDisplay display)
          add a display that will recieve broadcasts from the IDelegateBridge.getDisplayBroadvaster
 void addGameStepListener(GameStepListener listener)
           
 boolean canSave()
           
 IChannelMessenger getChannelMessenger()
           
 GameData getData()
           
 IMessenger getMessenger()
           
 PlayerManager getPlayerManager()
           
 IRandomSource getRandomSource()
           
 IRemoteMessenger getRemoteMessenger()
           
 Vault getVault()
           
 boolean isGameOver()
          Is the game over.
 void removeDisplay(IDisplay display)
          remove a display
 void removeGameStepListener(GameStepListener listener)
           
 void saveGame(java.io.File f)
          Save the game to the given directory.
 

Field Detail

GAME_MODIFICATION_CHANNEL

static final RemoteName GAME_MODIFICATION_CHANNEL
Method Detail

getData

GameData getData()

addGameStepListener

void addGameStepListener(GameStepListener listener)

removeGameStepListener

void removeGameStepListener(GameStepListener listener)

getMessenger

IMessenger getMessenger()

getChannelMessenger

IChannelMessenger getChannelMessenger()

getRemoteMessenger

IRemoteMessenger getRemoteMessenger()

getVault

Vault getVault()

addChange

void addChange(Change aChange)
Should not be called outside of engine code.


canSave

boolean canSave()

getRandomSource

IRandomSource getRandomSource()

addDisplay

void addDisplay(IDisplay display)
add a display that will recieve broadcasts from the IDelegateBridge.getDisplayBroadvaster


removeDisplay

void removeDisplay(IDisplay display)
remove a display


isGameOver

boolean isGameOver()
Is the game over. Game over does not relate to the state of the game (eg check-mate in chess) but to the game being shut down and all players have left.


getPlayerManager

PlayerManager getPlayerManager()
Returns:
a listing of who is playing who.

saveGame

void saveGame(java.io.File f)
Save the game to the given directory. The file should exist and be writeable.