gvprojects.igel.model
Interface IGameState

All Known Implementing Classes:
IgelGameKurmas

public interface IGameState

Interface describing the state of an IgelArgernFullPresenter game

Author:
Zachary Kurmas

Method Summary
 int currentDieValue()
          Get the current value on the die.
 java.lang.String currentMessage()
          Get the current message.
 int currentPlayer()
          Return the current player's number.
 ICellState getCell(int row, int column)
          return the ICellState object at the given location
 int hedgehogsPerPlayer()
          Return the number of hedgehogs per player.
 int numColumns()
          return the number of columns on the board.
 int numPlayers()
          Return the number of players.
 int numRows()
          return the number of rows on the board.
 Phase phase()
          Return the current game phase.
 

Method Detail

numPlayers

int numPlayers()
Return the number of players.

Returns:
the number of players

hedgehogsPerPlayer

int hedgehogsPerPlayer()
Return the number of hedgehogs per player.

Returns:
the number of hedgehogs per player.

phase

Phase phase()
Return the current game phase.

Returns:
the current game phase.

currentPlayer

int currentPlayer()
Return the current player's number.

Returns:
the current player's number

getCell

ICellState getCell(int row,
                   int column)
return the ICellState object at the given location

Parameters:
row - the row (indexed beginning at 0)
column - the column (indexed beginning at 0)
Returns:
the ICellState object at the given location
Throws:
java.lang.IllegalArgumentException - if row or column is invalid

numRows

int numRows()
return the number of rows on the board.

Returns:
the number of rows on the board.

numColumns

int numColumns()
return the number of columns on the board.

Returns:
the number of columns on the board.

currentDieValue

int currentDieValue()
Get the current value on the die.

Returns:
the current value on the die.

currentMessage

java.lang.String currentMessage()
Get the current message.

Returns:
the current message