JavaDOC fix: Board, Hunt, ShamanicRitual
This commit is contained in:
@@ -64,7 +64,7 @@ public class Hunt extends EventCard {
|
|||||||
/**
|
/**
|
||||||
* Creates and returns a copy of this Hunt card.
|
* Creates and returns a copy of this Hunt card.
|
||||||
*
|
*
|
||||||
* @return a new Hunt card with the same era and prestige multiplicator
|
* @return a new Hunt card with the same era and prestige multiplier
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public EventCard clone() {
|
public EventCard clone() {
|
||||||
|
|||||||
+1
-1
@@ -39,7 +39,7 @@ public class ShamanicRitual extends EventCard {
|
|||||||
* Activates the event card "Shamanic Ritual".
|
* Activates the event card "Shamanic Ritual".
|
||||||
* The player with the most icons gains the Prestige Points indicated.
|
* The player with the most icons gains the Prestige Points indicated.
|
||||||
* The player with the fewest icons loses the Prestige Points indicated.
|
* The player with the fewest icons loses the Prestige Points indicated.
|
||||||
* In case of a tie, all player gain or lose the Prestige Points indicated.
|
* In case of a tie, all players gain or lose the Prestige Points indicated.
|
||||||
* If all players have the same amount of icons, they all gain and lose Prestige Points.
|
* If all players have the same amount of icons, they all gain and lose Prestige Points.
|
||||||
*
|
*
|
||||||
* Buildings influence:
|
* Buildings influence:
|
||||||
|
|||||||
@@ -12,11 +12,11 @@ import java.util.*;
|
|||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Board manages all the elements during the game as decks, upper and lower rows, totems, tiles...
|
* Board manages all the elements during the game such as decks, upper and lower rows, totems, tiles...
|
||||||
*/
|
*/
|
||||||
public class Board {
|
public class Board {
|
||||||
/**
|
/**
|
||||||
* slotList contains the ordered list of slots (tiles). These changes based on the number of players.
|
* slotList contains the ordered list of slots (tiles). The slots changes based on the number of players.
|
||||||
* Each slot (tile) has special action as drawing from the upper/lower row or taking food.
|
* Each slot (tile) has special action as drawing from the upper/lower row or taking food.
|
||||||
*/
|
*/
|
||||||
private List<Slot> slotList;
|
private List<Slot> slotList;
|
||||||
@@ -28,9 +28,9 @@ public class Board {
|
|||||||
public List<TribeCard> upperListTribe;
|
public List<TribeCard> upperListTribe;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The lower row of the tribe card. During the first round there will be (num. of players + 1) character cards.
|
* The lower row of the tribe card. During the first round, there will be (num. of players + 1) character cards.
|
||||||
* During the following rounds, lower row will be emptied and populated with upper row's cards.
|
* During the following rounds, lower row will be emptied and populated with upper row's cards.
|
||||||
* When an Event card get in the lower row, the event effect will be activated at the wnd of the round.
|
* When an Event card gets in the lower row, the event effect will be activated at the end of the round.
|
||||||
*/
|
*/
|
||||||
public List<TribeCard> lowerListTribe;
|
public List<TribeCard> lowerListTribe;
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ public class Board {
|
|||||||
private int era;
|
private int era;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates and return a new list containing the slots (tiles) of the game
|
* Creates and returns a new list containing the slots (tiles) of the game
|
||||||
*
|
*
|
||||||
* @return a copy of the slot list
|
* @return a copy of the slot list
|
||||||
*/
|
*/
|
||||||
@@ -64,7 +64,7 @@ public class Board {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates and initialize a new board:
|
* Creates and initializes a new board:
|
||||||
* - Generate the slotList using a method of DecksCreator
|
* - Generate the slotList using a method of DecksCreator
|
||||||
* - Generate the tribeDeck
|
* - Generate the tribeDeck
|
||||||
* - Populate the lower list (if there is an event card, it's added to the upper list)
|
* - Populate the lower list (if there is an event card, it's added to the upper list)
|
||||||
@@ -111,7 +111,7 @@ public class Board {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates the tribeDeck. Loads the cards from each era, shuffle them, and then join them in the final deck.
|
* Creates the tribeDeck. Loads the cards from each era, shuffle them, and then combine them in the final deck.
|
||||||
* In the end, two special events (Sustenance and ShamanicRitual) are added.
|
* In the end, two special events (Sustenance and ShamanicRitual) are added.
|
||||||
*
|
*
|
||||||
* @param nPlayers the number of players
|
* @param nPlayers the number of players
|
||||||
@@ -138,7 +138,7 @@ public class Board {
|
|||||||
return tribeDeck_temp;
|
return tribeDeck_temp;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @return the queue of events from the lower list that need to be activated */
|
/** @return the queue of events cards from the lower list that need to be activated */
|
||||||
public Queue<EventCard> getPendingEvents(){
|
public Queue<EventCard> getPendingEvents(){
|
||||||
return lowerListTribe.stream().filter(TribeCard::IsEventCard).map(x->(EventCard)x).collect(Collectors.toCollection(LinkedList::new));
|
return lowerListTribe.stream().filter(TribeCard::IsEventCard).map(x->(EventCard)x).collect(Collectors.toCollection(LinkedList::new));
|
||||||
}
|
}
|
||||||
@@ -147,7 +147,7 @@ public class Board {
|
|||||||
* Take the selected card from the upper tribe list of the board
|
* Take the selected card from the upper tribe list of the board
|
||||||
*
|
*
|
||||||
* @param tribeCard is the card to remove
|
* @param tribeCard is the card to remove
|
||||||
* @return true if succeed in removing the card
|
* @return true if the card is succesfully removed
|
||||||
*/
|
*/
|
||||||
public boolean removeUpperTribeCard(TribeCard tribeCard) {
|
public boolean removeUpperTribeCard(TribeCard tribeCard) {
|
||||||
return upperListTribe.remove(tribeCard);
|
return upperListTribe.remove(tribeCard);
|
||||||
@@ -209,7 +209,7 @@ public class Board {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Change the era of the game:
|
* Changes the era of the game:
|
||||||
* - Increase the era attribute
|
* - Increase the era attribute
|
||||||
* - Clear the lower building list and replace it with the upper building list
|
* - Clear the lower building list and replace it with the upper building list
|
||||||
* - Repopulate the upper building list
|
* - Repopulate the upper building list
|
||||||
|
|||||||
Reference in New Issue
Block a user