summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/control/turn
diff options
context:
space:
mode:
Diffstat (limited to 'src/jrummikub/control/turn')
-rw-r--r--src/jrummikub/control/turn/ITurnControl.java30
1 files changed, 22 insertions, 8 deletions
diff --git a/src/jrummikub/control/turn/ITurnControl.java b/src/jrummikub/control/turn/ITurnControl.java
index ab4d6ae..62f9dfb 100644
--- a/src/jrummikub/control/turn/ITurnControl.java
+++ b/src/jrummikub/control/turn/ITurnControl.java
@@ -19,12 +19,12 @@ public interface ITurnControl {
* Start the turn
*
* @param info
- * the current turn state
+ * the current turn state
*
* @param settings
- * the game settings
+ * the game settings
* @param view
- * view for user interaction.
+ * view for user interaction.
*/
public void setup(TurnInfo info, GameSettings settings, IView view);
@@ -60,7 +60,8 @@ public interface ITurnControl {
public IEvent1<ITable> getTableUpdateEvent();
/**
- * The TurnInfo class encapsulates all information concerning the current turn
+ * The TurnInfo class encapsulates all information concerning the current
+ * turn
*/
public class TurnInfo {
private IRoundState roundState;
@@ -78,12 +79,15 @@ public interface ITurnControl {
/**
* Creates a new TurnInfo instance
*
- * @param hasLaidOut
- * has the player laid out yet?
+ * @param roundState
+ * current round state
* @param turnMode
- * the turn mode
+ * the turn mode
+ * @param mayPause
+ * player is allowed to paues
*/
- public TurnInfo(IRoundState roundState, TurnMode turnMode, boolean mayPause) {
+ public TurnInfo(IRoundState roundState, TurnMode turnMode,
+ boolean mayPause) {
this.roundState = roundState;
oldTable = roundState.getTable();
@@ -97,6 +101,11 @@ public interface ITurnControl {
this.mayPause = mayPause;
}
+ /**
+ * Get the current round state
+ *
+ * @return the current round state
+ */
public IRoundState getRoundState() {
return roundState;
}
@@ -155,6 +164,11 @@ public interface ITurnControl {
return turnMode;
}
+ /**
+ * Return whether pausing is allowed during this turn
+ *
+ * @return true if pause is allowed
+ */
public boolean isMayPause() {
return mayPause;
}