org.vizzini.game
Interface IGameState

All Superinterfaces:
IDocument, Serializable
All Known Implementing Classes:
AbstractGameState, DefaultGameState

public interface IGameState
extends Serializable, IDocument

Defines methods required by game states in the game framework. A game state stores all the data necessary to reproduce a particular game state.

Since:
v0.1
Version:
v0.1
Author:
Jeffrey M. Thompson

Method Summary
 IAgentCollection getAgentCollection()
          Return the agent collection.
 String getGameIdentifier()
          Return the game identifier.
 ITokenCollection getTokenCollection()
          Return the action collection.
 long getTurnNumber()
          Return the turn number.
 void setAgentCollection(IAgentCollection agentCollection)
          Set the agent collection.
 void setGameIdentifier(String gameIdentifier)
          Set the game identifier.
 void setTokenCollection(ITokenCollection tokenCollection)
          Set the token collection.
 void setTurnNumber(long turnNumber)
          Set the turn number.
 
Methods inherited from interface org.vizzini.util.IDocument
addDirtyListener, addFileListener, getFile, isDirty, isFileAssociated, isSaveable, open, removeDirtyListener, removeFileListener, reset, save, saveAs, setDirty, setFile
 

Method Detail

setAgentCollection

void setAgentCollection(IAgentCollection agentCollection)
Set the agent collection.

Since:
v0.1

getAgentCollection

IAgentCollection getAgentCollection()
Return the agent collection.

Since:
v0.1

setGameIdentifier

void setGameIdentifier(String gameIdentifier)
Set the game identifier.

Since:
v0.1

getGameIdentifier

String getGameIdentifier()
Return the game identifier.

Since:
v0.1

setTokenCollection

void setTokenCollection(ITokenCollection tokenCollection)
Set the token collection.

Since:
v0.1

getTokenCollection

ITokenCollection getTokenCollection()
Return the action collection.

Since:
v0.1

setTurnNumber

void setTurnNumber(long turnNumber)
Set the turn number.

Since:
v0.1

getTurnNumber

long getTurnNumber()
Return the turn number.

Since:
v0.1


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02