Add: complete javadoc on model and network
This commit is contained in:
@@ -62,7 +62,14 @@ public class MiniModel implements Serializable {
|
||||
public MiniModel() {
|
||||
}
|
||||
|
||||
//TODO
|
||||
/**
|
||||
* Constructs a mini model with only the card lists populated.
|
||||
*
|
||||
* @param upperListTribeCards the upper row of tribe cards on the board.
|
||||
* @param lowerListTribeCards the lower row of tribe cards on the board.
|
||||
* @param upperListBuildingCards the upper row of building cards on the board.
|
||||
* @param lowerListBuildingCards the lower row of building cards on the board.
|
||||
*/
|
||||
public MiniModel(ArrayList<TribeCard> upperListTribeCards,ArrayList<TribeCard>lowerListTribeCards,ArrayList<BuildingCard> upperListBuildingCards,ArrayList<BuildingCard>lowerListBuildingCards) {
|
||||
this.upperListTribeCards = upperListTribeCards;
|
||||
this.lowerListTribeCards = lowerListTribeCards;
|
||||
@@ -74,12 +81,16 @@ public class MiniModel implements Serializable {
|
||||
/**
|
||||
* Constructs a complete mini model from the current server-side game data.
|
||||
*
|
||||
*TODO
|
||||
* @param slotPlayerMap the map associating occupied slots with players.
|
||||
* @param orderLogicCard the card managing player turn order.
|
||||
* @param currentState the current state of the game.
|
||||
* @param players the list of players in the match.
|
||||
* @param availableTotems the list of totems still available for selection.
|
||||
* @param slotPlayerMap the map associating occupied slots with players.
|
||||
* @param orderLogicCard the card managing player turn order.
|
||||
* @param currentState the current state of the game.
|
||||
* @param players the list of players in the match.
|
||||
* @param availableTotems the list of totems still available for selection.
|
||||
* @param upperListTribeCards the upper row of tribe cards on the board.
|
||||
* @param lowerListTribeCards the lower row of tribe cards on the board.
|
||||
* @param upperListBuildingCards the upper row of building cards on the board.
|
||||
* @param lowerListBuildingCards the lower row of building cards on the board.
|
||||
* @param disconnectedPlayers the list of usernames of currently disconnected players.
|
||||
*/
|
||||
public MiniModel(Map<Slot, Player> slotPlayerMap,
|
||||
OrderLogicCard orderLogicCard,
|
||||
@@ -101,7 +112,11 @@ public class MiniModel implements Serializable {
|
||||
setPlayers(players);
|
||||
}
|
||||
|
||||
//TODO
|
||||
/**
|
||||
* Sets the last network event applied to the game state.
|
||||
*
|
||||
* @param lastEvent the most recent event received from the server.
|
||||
*/
|
||||
public void setLastEvent(NetworkEvent lastEvent) {
|
||||
this.lastEvent = lastEvent;
|
||||
}
|
||||
@@ -193,7 +208,11 @@ public class MiniModel implements Serializable {
|
||||
return -1;
|
||||
}
|
||||
|
||||
//TODO
|
||||
/**
|
||||
* Sets the list of usernames of currently disconnected players.
|
||||
*
|
||||
* @param disconnectedPlayers the list of disconnected player usernames.
|
||||
*/
|
||||
public void setDisconnectedPlayers (ArrayList<String> disconnectedPlayers){
|
||||
this.disconnectedPlayers=disconnectedPlayers;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user