Package it.polimi.ingsw.server.model.game_logic

Class ExpertGameState

java.lang.Object

it.polimi.ingsw.server.event_sourcing.Aggregate

it.polimi.ingsw.server.model.game_logic.GameState

it.polimi.ingsw.server.model.game_logic.ExpertGameState

All Implemented Interfaces:

GameStateCommonInterface

public class ExpertGameState
extends GameState

Field Summary

Fields

Modifier and Type	Field	Description
private final List<PlayableCharacter>	availableCharacters
protected PlayableCharacter	characterPlayedInCurrentTurn

Fields inherited from class it.polimi.ingsw.server.model.game_logic.GameState

archipelagos, clouds, currentPlayerSchoolBoardId, motherNaturePosition, numberOfPlayers, round, schoolBoardIdsToCardPlayedThisRound, schoolBoardIdsToLastCardPlayed, schoolBoards, strategy, studentFactory

Fields inherited from class it.polimi.ingsw.server.event_sourcing.Aggregate

created, id, repository, version

Constructor Summary

Constructors

Modifier	Constructor	Description
	ExpertGameState(int playersNumber)
protected	ExpertGameState(int playersNumber, List<PlayableCharacter> availableCharacters)	ONLY FOR TESTING

Method Summary

Modifier and Type	Method	Description
void	assignProfessorsAfterEffect()	This method resets the ownership (with the normal rules) of every professor after the effect of the character is finished
protected void	assignProfessorsWithEffect()	This method assigns the professors after the activation of the effect of the character with ID 2
protected void	chooseStrategy()	This method chooses the appropriate strategy according to the number of players
protected boolean	compareCurrentPlayersStudentsNumberWithOthersMax(int currentPlayerNumberOfStudentsInDiningRoomLane, int otherSchoolBoardsMaxStudentsInDiningRoomLane)
protected ExpertArchipelago	createArchipelago(int code)	This method created an archipelago for the expert mode
void	createSnapshot()	Generates the snapshot and saves the Aggregate updated information to the repository
private void	extractCharacters()	This method randomly extracts 3 different characters with which the game will be played.
private int	getAdditionalSteps()
protected int	getAllowedStepsNumber()
List<PlayableCharacter>	getAvailableCharacters()
Optional<Map<Integer,Integer>>	getInfluence(List<Integer> archipelagoIslandCodes)	This method gets an archipelago in input and returns a map where every entry links a schoolBoard with its influence on the inputted archipelago
protected List<SchoolBoard>	initializeSchoolBoards()	This method initializes the schoolBoards according to the appropriate strategy depending on the number of players.
LightGameState	lightify()	This method returns the light version of the GameState, with all the useful information to be sent over the network
private void	lockArchipelago(Archipelago archipelagoToLock)
private void	payCharacter()
void	playCharacterLock(int archipelagoIslandCode)	This method executes the effect of the character with ID 5.
void	playColorDoesntCount(Color color)	This method executes the effect of the character with ID 9.
void	playGetProfessorsWithSameStudents()	This method executes the effect of the character with ID 2.
boolean	playMoveMotherNatureToAnyArchipelago(int archipelagoIslandCode)	This method executes the effect of the character with ID 3.
void	playPutOneStudentFromCharacterToArchipelago(Color color, int archipelagoIslandCode)	This method executes the effect of the character with ID 1.
void	playPutOneStudentFromCharacterToDiningRoom(Color color)	This method executes the effect of the character with ID 11.
void	playPutThreeStudentsInTheBag(Color color)	This method executes the effect of the character with ID 12.
void	playSwapThreeStudentsBetweenCharacterAndEntrance(List<Color> studentsFromCharacter, List<Color> studentsFromEntrance)	This method executes the effect of the character with ID 7.
void	playSwapTwoStudentsBetweenEntranceAndDiningRoom(List<Color> studentFromEntrance, List<Color> studentsFromDiningRoom)	This method executes the effect of the character with ID 10.
void	playTowersDontCount()	This method executes the effect of the character with ID 6.
void	playTwoAdditionalInfluence()	This method executes the effect of the character with ID 8.
void	playTwoAdditionalSteps()	This method executes the effect of the character with ID 4.
private void	putOneStudentFromCharacterToDiningRoom(PlayableCharacter selectedCharacter, Color student)
private void	putThreeStudentsInTheBag(Color color)
void	refillCharacter()	This method refills the PlayableCHaracter that was played during the turn
private void	refillGivenCharacter(PlayableCharacter playableCharacter)	This method refills the PlayableCharactersWithStudents that may have been used during a turn
void	resetCharacterPlayedThisTurn()
void	resetColorThatDoesntCountForAllArchipelagos()
Aggregate	rollback()	Recreates the aggregate based on the last snapshot, deletes all the events vit aggregate version > snapshot version
private void	setColorThatDoesntCountForAllArchipelagos(Color color)
void	setTowersInfluenceForAllArchipelagos(boolean doTowersCount)
void	unlockMotherNaturePosition()	This method unlocks the archipelago onto which mother nature terminates its movement
boolean	wasCharacterPlayedInCurrentTurn()

Methods inherited from class it.polimi.ingsw.server.model.game_logic.GameState

apply, assignProfessor, assignProfessorHandler, checkWinners, conquerArchipelago, conquerArchipelagoHandler, fillCloud, fillCloudHandler, fillClouds, getActionPhaseSubTurn, getArchipelagoFromIslandCodes, getArchipelagoFromSingleIslandCode, getArchipelagosForTesting, getClouds, getCurrentPhase, getCurrentPlayerSchoolBoard, getCurrentPlayerSchoolBoardForTesting, getCurrentPlayerSchoolBoardId, getCurrentRound, getInitialNumberOfStudentsInTheEntrance, getMostInfluentSchoolBoardId, getMotherNaturePositionIslandCodes, getNextTurn, getNextTurnHandler, getNumberOfMovableStudents, getNumberOfPlayers, getNumberOfStudentsInTheEntrance, getPreviousArchipelago, getSchoolBoardFromSchoolBoardId, getSchoolBoardIDFromTowerColor, getSchoolBoardIds, getSchoolBoardIdsToCardPlayedThisRound, getSchoolBoardIdsToCardsPlayedThisRoundForTesting, getTowerColorFromSchoolBoardId, grabStudentsFromCloud, grabStudentsFromCloudHandler, increaseRoundCount, increaseRoundCountHandler, initGameState, isLastRound, isLastTurnInThisRound, mergeWithNext, mergeWithNextHandler, mergeWithPrevious, mergeWithPreviousHandler, moveMotherNatureNStepsClockwise, moveMotherNatureNStepsClockwiseHandler, moveMotherNatureOneStepClockwise, moveStudentFromEntranceToArchipelago, moveStudentFromEntranceToArchipelagoHandler, moveStudentFromEntranceToDiningHandler, moveStudentFromEntranceToDiningRoom, playCard, playCardHandler, resetRoundIterator, resetRoundIteratorHandler, resetSchoolBoardIdsToCardsPlayerThisRound, resetSchoolBoardIdsToCardsPlayerThisRoundHandler, setActionPhaseSubTurn, setActionPhaseSubTurnHandler, setCurrentPhase, setCurrentPhaseHandler, setCurrentPlayerSchoolBoardId, setCurrentPlayerSchoolBoardIdHandler, setLastRoundTrue, setMotherNaturePositionForTesting, setRoundOrder, setRoundOrderHandler

Methods inherited from class it.polimi.ingsw.server.event_sourcing.Aggregate

getCurrentState, loadFromUuid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

availableCharacters

private final List<PlayableCharacter> availableCharacters

characterPlayedInCurrentTurn

protected PlayableCharacter characterPlayedInCurrentTurn

Constructor Details

ExpertGameState

public ExpertGameState(int playersNumber)
                throws GameStateInitializationFailureException

Parameters:

playersNumber - number of players in the game, must be between 2 (inclusive) and 4 (inclusive)

Throws:

IllegalArgumentException - if the argument representing the number of players is not between 2 and 4

GameStateInitializationFailureException - if there is a problem in the initialization of the archipelagos or the schoolBoards, or the clouds.

ExpertGameState

protected ExpertGameState(int playersNumber,
 List<PlayableCharacter> availableCharacters)
                   throws GameStateInitializationFailureException,
EmptyStudentSupplyException

ONLY FOR TESTING

Throws:

GameStateInitializationFailureException

EmptyStudentSupplyException

Method Details

chooseStrategy

protected void chooseStrategy()

This method chooses the appropriate strategy according to the number of players

Overrides:

chooseStrategy in class GameState

createArchipelago

protected ExpertArchipelago createArchipelago(int code)

This method created an archipelago for the expert mode

Overrides:

createArchipelago in class GameState

Parameters:

code - is the starting islandCode of the archipelago

Returns:

the newly created archipelago

initializeSchoolBoards

protected List<SchoolBoard> initializeSchoolBoards()
                                            throws EmptyStudentSupplyException

This method initializes the schoolBoards according to the appropriate strategy depending on the number of players.

Overrides:

initializeSchoolBoards in class GameState

Returns:

a List of SchoolBoard containing the already initialized schoolBoards, students in the entrance included.

Throws:

EmptyStudentSupplyException - if the studentSupply representing the bag is empty and cannot fulfill the initialization process

extractCharacters

private void extractCharacters()
                        throws EmptyStudentSupplyException

This method randomly extracts 3 different characters with which the game will be played.

Throws:

EmptyStudentSupplyException

refillGivenCharacter

private void refillGivenCharacter(PlayableCharacter playableCharacter)
                           throws EmptyStudentSupplyException

This method refills the PlayableCharactersWithStudents that may have been used during a turn

Parameters:

playableCharacter - is the PlayableCharacter to be refilled

Throws:

EmptyStudentSupplyException - if the student supply is empty and the refill couldn't be completed

refillCharacter

public void refillCharacter()
                     throws EmptyStudentSupplyException

This method refills the PlayableCHaracter that was played during the turn

Throws:

EmptyStudentSupplyException - if the student supply is empty and the refill couldn't be completed

playPutOneStudentFromCharacterToArchipelago

public void playPutOneStudentFromCharacterToArchipelago(Color color,
 int archipelagoIslandCode)
                                                 throws MoveNotAvailableException,
InvalidArchipelagoIdException,
StudentNotOnCharacterException,
NotEnoughCoinsException

This method executes the effect of the character with ID 1. It takes one student from the character and puts it on the inputted archipelago

Parameters:

color - represents the student to be moved

archipelagoIslandCode - represent the archipelago onto which the inputted student will be moved

Throws:

MoveNotAvailableException - if the move is not available in the game

InvalidArchipelagoIdException - if the inputted archipelago code is invalid

StudentNotOnCharacterException - if the inputted student is not actually present on character

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

playGetProfessorsWithSameStudents

public void playGetProfessorsWithSameStudents()
                                       throws MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 2. It allows the player to take control of the a professor even if he has the same number of students on the corresponding diningRoom table

Throws:

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

compareCurrentPlayersStudentsNumberWithOthersMax

protected boolean compareCurrentPlayersStudentsNumberWithOthersMax(int currentPlayerNumberOfStudentsInDiningRoomLane,
 int otherSchoolBoardsMaxStudentsInDiningRoomLane)

Overrides:

compareCurrentPlayersStudentsNumberWithOthersMax in class GameState

assignProfessorsWithEffect

protected void assignProfessorsWithEffect()

This method assigns the professors after the activation of the effect of the character with ID 2

assignProfessorsAfterEffect

public void assignProfessorsAfterEffect()

This method resets the ownership (with the normal rules) of every professor after the effect of the character is finished

playMoveMotherNatureToAnyArchipelago

public boolean playMoveMotherNatureToAnyArchipelago(int archipelagoIslandCode)
                                             throws InvalidArchipelagoIdException,
MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 3. It allows the player to move mother nature to any archipelago.

Parameters:

archipelagoIslandCode - represent an archipelago through one of its codes

Returns:

true if the archipelagos merged as a result, false otherwise

Throws:

InvalidArchipelagoIdException - if the inputted archipelago code is invalid

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

playTwoAdditionalSteps

public void playTwoAdditionalSteps()
                            throws MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 4. It allows the player to move mother nature for 2 additional steps.

Throws:

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

getAdditionalSteps

private int getAdditionalSteps()

getAllowedStepsNumber

protected int getAllowedStepsNumber()

Overrides:

getAllowedStepsNumber in class GameState

lockArchipelago

private void lockArchipelago(Archipelago archipelagoToLock)
                      throws ArchipelagoAlreadyLockedException

Parameters:

archipelagoToLock - is the archipelago that will be locked

Throws:

ArchipelagoAlreadyLockedException - if the inputted Archipelago is already locked

playCharacterLock

public void playCharacterLock(int archipelagoIslandCode)
                       throws NoAvailableLockException,
InvalidArchipelagoIdException,
ArchipelagoAlreadyLockedException,
MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 5. It allows the player to lock an archipelago of choice.

Parameters:

archipelagoIslandCode - represent an archipelago through one of its codes

Throws:

NoAvailableLockException - if there are no locks available on the character

InvalidArchipelagoIdException - if the inputted archipelago code is invalid

ArchipelagoAlreadyLockedException - if the inputted Archipelago is already locked

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

unlockMotherNaturePosition

public void unlockMotherNaturePosition()

This method unlocks the archipelago onto which mother nature terminates its movement

setTowersInfluenceForAllArchipelagos

public void setTowersInfluenceForAllArchipelagos(boolean doTowersCount)

Parameters:

doTowersCount - is true if the towers will have to count during the influence calculation, false otherwise

playTowersDontCount

public void playTowersDontCount()
                         throws MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 6. It sets the influence given by the towers on every archipelago to zero.

Throws:

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

playSwapThreeStudentsBetweenCharacterAndEntrance

public void playSwapThreeStudentsBetweenCharacterAndEntrance(List<Color> studentsFromCharacter,
 List<Color> studentsFromEntrance)
                                                      throws InvalidStudentListsLengthException,
MoveNotAvailableException,
StudentNotOnCharacterException,
StudentNotInTheEntranceException,
NotEnoughCoinsException

This method executes the effect of the character with ID 7. It allows the player to swap up to three students between its schoolBoard's entrance and the character

Parameters:

studentsFromCharacter - is a list representing the students to get from the character

studentsFromEntrance - is a list representing the students to give from the entrance

Throws:

InvalidStudentListsLengthException - if the two inputted lists have different lengths

StudentNotOnCharacterException - if one of the elements of studentsFromCharacter is not actually present on the character

StudentNotInTheEntranceException - if one of the elements of studentsFromCharacter is not actually present in the entrance

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

playTwoAdditionalInfluence

public void playTwoAdditionalInfluence()
                                throws MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 8. It allows the player to get 2 additional units of influence during the influence calculation.

Throws:

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

getInfluence

public Optional<Map<Integer,Integer>> getInfluence(List<Integer> archipelagoIslandCodes)

This method gets an archipelago in input and returns a map where every entry links a schoolBoard with its influence on the inputted archipelago

Overrides:

getInfluence in class GameState

Parameters:

archipelagoIslandCodes - is a List of Integer uniquely identifying an archipelago

Returns:

a Map Integer, Integer where the key is the schoolBoardId and the value is the influence on the inputted archipelago

setColorThatDoesntCountForAllArchipelagos

private void setColorThatDoesntCountForAllArchipelagos(Color color)

playColorDoesntCount

public void playColorDoesntCount(Color color)
                          throws MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 9. It allows the player to choose a color that won't count during the influence calculation.

Parameters:

color - is the color that won't count during the influence calculation

Throws:

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

resetColorThatDoesntCountForAllArchipelagos

public void resetColorThatDoesntCountForAllArchipelagos()

playSwapTwoStudentsBetweenEntranceAndDiningRoom

public void playSwapTwoStudentsBetweenEntranceAndDiningRoom(List<Color> studentFromEntrance,
 List<Color> studentsFromDiningRoom)
                                                     throws InvalidStudentListsLengthException,
MoveNotAvailableException,
StudentNotInTheEntranceException,
FullDiningRoomLaneException,
StudentsNotInTheDiningRoomException,
NotEnoughCoinsException

This method executes the effect of the character with ID 10. It allows the player to swap up to two students between its entrance and diningRoom.

Parameters:

studentFromEntrance - is the list of students to get from the entrance

studentsFromDiningRoom - is the list of students to get from the diningRoom

Throws:

InvalidStudentListsLengthException - if the two inputted lists have different lengths

StudentNotInTheEntranceException - if one of the elements of studentsFromCharacter is not actually present in the entrance

FullDiningRoomLaneException - if the diningRoom table corresponding to one of the colors is full

StudentsNotInTheDiningRoomException - if the one of the elements of studentsFromEntrance is not actually present in the entrance

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

putOneStudentFromCharacterToDiningRoom

private void putOneStudentFromCharacterToDiningRoom(PlayableCharacter selectedCharacter,
 Color student)
                                             throws StudentNotOnCharacterException,
FullDiningRoomLaneException

Throws:

StudentNotOnCharacterException

FullDiningRoomLaneException

playPutOneStudentFromCharacterToDiningRoom

public void playPutOneStudentFromCharacterToDiningRoom(Color color)
                                                throws StudentNotOnCharacterException,
FullDiningRoomLaneException,
MoveNotAvailableException,
NotEnoughCoinsException

This method executes the effect of the character with ID 11. It allows the player to get one student from the character and put it into his diningRoom

Parameters:

color - represents the student to be moved from the character to the diningRoom

Throws:

StudentNotOnCharacterException - if one of the elements of studentsFromCharacter is not actually present on the character

FullDiningRoomLaneException - if the diningRoom table corresponding to one of the colors is full

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

putThreeStudentsInTheBag

private void putThreeStudentsInTheBag(Color color)
                               throws StudentsNotInTheDiningRoomException

Throws:

StudentsNotInTheDiningRoomException

playPutThreeStudentsInTheBag

public void playPutThreeStudentsInTheBag(Color color)
                                  throws MoveNotAvailableException,
NotEnoughCoinsException,
StudentsNotInTheDiningRoomException

This method executes the effect of the character with ID 12. It makes every player to get three students of the inputted color from the diningRoom and put them into the bag

Parameters:

color - is the color of the students that have to be removed from the diningRoom

Throws:

StudentsNotInTheDiningRoomException - if the one of the elements of studentsFromEntrance is not actually present in the entrance

MoveNotAvailableException - if the move is not available in the game

NotEnoughCoinsException - if the player doesn't have enough coins to activate the character

getAvailableCharacters

public List<PlayableCharacter> getAvailableCharacters()

wasCharacterPlayedInCurrentTurn

public boolean wasCharacterPlayedInCurrentTurn()

resetCharacterPlayedThisTurn

public void resetCharacterPlayedThisTurn()

payCharacter

private void payCharacter()

lightify

public LightGameState lightify()

This method returns the light version of the GameState, with all the useful information to be sent over the network

Overrides:

lightify in class GameState

Returns:

a LightGameState representing the light version of the GameState, with all the useful information to be sent over the network

createSnapshot

public void createSnapshot()

Description copied from class: Aggregate

Generates the snapshot and saves the Aggregate updated information to the repository

Overrides:

createSnapshot in class Aggregate

rollback

public Aggregate rollback()

Description copied from class: Aggregate

Recreates the aggregate based on the last snapshot, deletes all the events vit aggregate version > snapshot version

Overrides:

rollback in class Aggregate

Returns:

the Aggregate Snapshot