added java docs to model/game and wrote the remaining getter and setter
This commit is contained in:
@@ -5,7 +5,9 @@
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* This class will be used to handle the data stored in the model
|
||||
* The Game class represents the game state of the Ludo game.
|
||||
* It contains all the information needed to play the game.
|
||||
* The game state is updated by the game logic.
|
||||
*/
|
||||
public class Game {
|
||||
private int diceModifier = 1;
|
||||
@@ -22,6 +24,9 @@ public class Game {
|
||||
private static final int AMOUNT_OF_TURBO_CARDS = 16;
|
||||
private static final int AMOUNT_OF_SHIELD_AND_SWAP_CARDS = 12;
|
||||
|
||||
/**
|
||||
* This constructor creates a new Game object.
|
||||
*/
|
||||
public Game(){
|
||||
gameStatistics = new Statistic();
|
||||
drawPile = new ArrayList<>();
|
||||
@@ -34,4 +39,223 @@ public Game(){
|
||||
}
|
||||
board = new Board();
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the dice modifier.
|
||||
*
|
||||
* @return the dice modifier
|
||||
*/
|
||||
public int getDiceModifier() {
|
||||
return diceModifier;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the dice modifier.
|
||||
*
|
||||
* @param diceModifier the new dice modifier
|
||||
*/
|
||||
public void setDiceModifier(int diceModifier) {
|
||||
this.diceModifier = diceModifier;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the dice eyes.
|
||||
*
|
||||
* @return the dice eyes
|
||||
*/
|
||||
public int getDiceEyes() {
|
||||
return diceEyes;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the dice eyes.
|
||||
*
|
||||
* @param diceEyes the new dice eyes
|
||||
*/
|
||||
public void setDiceEyes(int diceEyes) {
|
||||
this.diceEyes = diceEyes;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the players.
|
||||
*
|
||||
* @return the players
|
||||
*/
|
||||
public Map<Color, Player> getPlayers() {
|
||||
return players;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the players.
|
||||
*
|
||||
* @param players the new players
|
||||
*/
|
||||
public void setPlayers(Map<Color, Player> players) {
|
||||
this.players = players;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the game statistics.
|
||||
*
|
||||
* @return the game statistics
|
||||
*/
|
||||
public Statistic getGameStatistics() {
|
||||
return gameStatistics;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the game statistics.
|
||||
*
|
||||
* @param gameStatistics the new game statistics
|
||||
*/
|
||||
public void setGameStatistics(Statistic gameStatistics) {
|
||||
this.gameStatistics = gameStatistics;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the draw pile.
|
||||
*
|
||||
* @return the draw pile
|
||||
*/
|
||||
public ArrayList<Card> getDrawPile() {
|
||||
return drawPile;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the draw pile.
|
||||
*
|
||||
* @param drawPile the new draw pile
|
||||
*/
|
||||
public void setDrawPile(ArrayList<Card> drawPile) {
|
||||
this.drawPile = drawPile;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the discard pile.
|
||||
*
|
||||
* @return the discard pile
|
||||
*/
|
||||
public ArrayList<Card> getDiscardPile() {
|
||||
return discardPile;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the discard pile.
|
||||
*
|
||||
* @param discardPile the new discard pile
|
||||
*/
|
||||
public void setDiscardPile(ArrayList<Card> discardPile) {
|
||||
this.discardPile = discardPile;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the board.
|
||||
*
|
||||
* @return the board
|
||||
*/
|
||||
public Board getBoard() {
|
||||
return board;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the board.
|
||||
*
|
||||
* @param board the new board
|
||||
*/
|
||||
public void setBoard(Board board) {
|
||||
this.board = board;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the active color.
|
||||
*
|
||||
* @return the active color
|
||||
*/
|
||||
public Color getActiveColor() {
|
||||
return activeColor;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the active color.
|
||||
*
|
||||
* @param activeColor the new active color
|
||||
*/
|
||||
public void setActiveColor(Color activeColor) {
|
||||
this.activeColor = activeColor;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the order of the players.
|
||||
*
|
||||
* @return the order of the players
|
||||
*/
|
||||
public LinkedList<Color> getOrder() {
|
||||
return order;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the order of the players.
|
||||
*
|
||||
* @param order the new order of the players
|
||||
*/
|
||||
public void setOrder(LinkedList<Color> order) {
|
||||
this.order = order;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the player connection ID.
|
||||
*
|
||||
* @return the player connection ID
|
||||
*/
|
||||
public Map<Color, Integer> getPlayerConnectionID() {
|
||||
return playerConnectionID;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the player connection ID.
|
||||
*
|
||||
* @param playerConnectionID the new player connection ID
|
||||
*/
|
||||
public void setPlayerConnectionID(Map<Color, Integer> playerConnectionID) {
|
||||
this.playerConnectionID = playerConnectionID;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the player connection ID.
|
||||
*
|
||||
* @param color the color of the player
|
||||
* @param connectionID the new connection ID
|
||||
*/
|
||||
public void setPlayerConnectionID(Color color, int connectionID) {
|
||||
playerConnectionID.put(color, connectionID);
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the player connection ID.
|
||||
*
|
||||
* @param color the color of the player
|
||||
* @return the player connection ID
|
||||
*/
|
||||
public int getPlayerConnectionID(Color color) {
|
||||
return playerConnectionID.get(color);
|
||||
}
|
||||
|
||||
/**
|
||||
* This method adds a player to the game.
|
||||
*
|
||||
* @param color the color of the player
|
||||
* @param player the player to be added
|
||||
*/
|
||||
public void addPlayer(Color color, Player player) {
|
||||
players.put(color, player);
|
||||
}
|
||||
|
||||
/**
|
||||
* This method removes a player from the game.
|
||||
*
|
||||
* @param color the color of the player
|
||||
*/
|
||||
public void removePlayer(Color color) {
|
||||
players.remove(color);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user