summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/model/IGameState.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jrummikub/model/IGameState.java')
-rw-r--r--src/jrummikub/model/IGameState.java36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/jrummikub/model/IGameState.java b/src/jrummikub/model/IGameState.java
index 8e64bc4..ebc31c5 100644
--- a/src/jrummikub/model/IGameState.java
+++ b/src/jrummikub/model/IGameState.java
@@ -1,20 +1,56 @@
package jrummikub.model;
+/**
+ * Interface for {@link GameState} model
+ */
public interface IGameState {
+ /**
+ * Get the current {@link Table}
+ *
+ * @return The current Table
+ */
public ITable getTable();
+ /**
+ * Sets the current {@link Table}
+ *
+ * @param table
+ * The new Table
+ */
public void setTable(ITable table);
+ /**
+ * Returns the number of players
+ *
+ * @return number of players
+ */
public int getPlayerCount();
/** Changes the activePlayer to the next {@link Player} in the list */
public void nextPlayer();
+ /**
+ * Returns the currently active player
+ *
+ * @return currently active player
+ */
public IPlayer getActivePlayer();
+ /**
+ * Returns the heap of stones to draw from
+ *
+ * @return heap of stones
+ */
public StoneHeap getGameHeap();
+ /**
+ * Returns the player that would be the active player after i turns
+ *
+ * @param i
+ * number of turns
+ * @return player active after i turns
+ */
public IPlayer getNthNextPlayer(int i);
} \ No newline at end of file