diff options
Diffstat (limited to 'src/jrummikub/view/ISidePanel.java')
-rw-r--r-- | src/jrummikub/view/ISidePanel.java | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/jrummikub/view/ISidePanel.java b/src/jrummikub/view/ISidePanel.java index 9efea85..b78ff39 100644 --- a/src/jrummikub/view/ISidePanel.java +++ b/src/jrummikub/view/ISidePanel.java @@ -5,14 +5,42 @@ import java.util.List; import jrummikub.model.GameSettings; import jrummikub.model.IPlayer; +/** + * Side panel to show all players and relevant player information in round + * order, game settings and stone heap size + */ public interface ISidePanel { + /** + * Sets the game settings to top of side panel + * + * @param settings + * current game settings + */ public void setGameSettings(GameSettings settings); + /** + * Sets the total heap size for progress bar + * + * @param capacity + * total heap size + */ void setHeapCapacity(int capacity); + /** + * Sets the current heap size + * + * @param size + * number of stones in current heap + */ void setHeapSize(int size); + /** + * Sets the player information in order of turns + * + * @param players + * players in current game + */ void setPlayers(List<IPlayer> players); }
\ No newline at end of file |