Module AM37

Package it.polimi.ingsw.model

Class Player

java.lang.Object

it.polimi.ingsw.model.Player

All Implemented Interfaces:

PlayerInterface

public class Player
extends java.lang.Object
implements PlayerInterface

Representation of a Player during a game

Constructor Summary

Constructors

Constructor	Description
Player(java.lang.String name, God god, Color color)	Creates a new Player, assigning its name, the god it chose and the color assigned to its workers.

Method Summary

Modifier and Type	Method	Description
void	addBuildableCellsListener(BuildableCellsListener buildableCellsListener)	Adds a new listener
void	addBuildingBlocksListener(BuildingBlocksListener buildingBlocksListener)	Adds a new listener
void	addSelectWorkerListener(SelectWorkerListener selectWorkerListener)	Adds a new listener
void	addWalkableCellsListener(WalkableCellsListener walkableCellsListener)	Adds a new listener
void	addWorker(Cell cell)	Adds a worker to the board
void	addWorkerListener(AddWorkerListener addWorkerListener)	Adds a new listener
boolean	allWorkersArePlaced()	Checks if the player has placed all of its workers
void	askPassTurn()	Ends the player's turn
PlayerData	buildDataClass()	Creates a PlayerData object based on this player
Player	clonePlayer(Game game)	Creates a clone of this object
boolean	equals(java.lang.Object o)	Compares the argument to the receiver, and answers true if their names are equals
Color	getColor()	color getter
God	getGod()	god getter
java.lang.String	getName()	name getter
Worker	getSelectedWorker()	selectedWorker getter
java.util.List<Worker>	getWorkers()	Gets all Player's workers
int	hashCode()
void	obtainBuildableCells()	Provides a list of cells on which the selected player can build on
void	obtainBuildingBlocks(Cell selectedCell)	Provides a list of blocks which the selected worker can build on the given cell
void	obtainWalkableCells()	Provides a list of cells on which the selected player can walk to
void	resetSelectedWorker()	Resets the worker to perform the next action to null
void	setGame(Game game)	Sets what game the Player is playing
void	setSelectedWorker(Worker selectedWorker)	Sets the worker to perform the next action
void	useAction(Action action)	Applies the given action

Methods inherited from class java.lang.Object

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

Constructor Details

Player

public Player(java.lang.String name, God god, Color color)

Creates a new Player, assigning its name, the god it chose and the color assigned to its workers.

Since some Gods allow the player to have more than two workers, the constructor initializes the workers as an empty list; the workers will then be created and assigned to the player with the addWorker(Cell) method.
Regarding the game attribute, it is not assigned in the constructor, since the Game is created after the creation of the players.

Parameters:

name - the player's username

god - the player's God card, chosen before the game is created

color - the player's workers color, automatically determined before the game is created

Method Details

setGame

public void setGame(Game game)

Sets what game the Player is playing

Parameters:

game - game

See Also:

Game(GameBoard, List)

getWorkers

public java.util.List<Worker> getWorkers()

Gets all Player's workers

Returns:

a list containing all the player's workers workers

addWorker

public void addWorker(Cell cell) throws AddingFailedException

Adds a worker to the board

Specified by:

addWorker in interface PlayerInterface

Parameters:

cell - the cell to place the worker to

Throws:

AddingFailedException - if the target cell is already occupied or all the workers are already placed

allWorkersArePlaced

public boolean allWorkersArePlaced()

Checks if the player has placed all of its workers

Specified by:

allWorkersArePlaced in interface PlayerInterface

Returns:

true if all the player's workers have been placed, false otherwise

useAction

public void useAction(Action action) throws IllegalActionException

Applies the given action

Specified by:

useAction in interface PlayerInterface

Parameters:

action - the action to be applied

Throws:

IllegalActionException - if the action cannot be performed

askPassTurn

public void askPassTurn() throws IllegalEndingTurnException

Ends the player's turn

Specified by:

askPassTurn in interface PlayerInterface

Throws:

IllegalEndingTurnException - if the turn cannot be ended

getGod

public God getGod()

god getter

Returns:

the player's god

getColor

public Color getColor()

color getter

Returns:

the player's workers color

getName

public java.lang.String getName()

name getter

Returns:

the player's username

getSelectedWorker

public Worker getSelectedWorker()

selectedWorker getter

Returns:

the worker selected to perform the next action

setSelectedWorker

public void setSelectedWorker(Worker selectedWorker) throws NotYourWorkerException

Sets the worker to perform the next action

Specified by:

setSelectedWorker in interface PlayerInterface

Parameters:

selectedWorker - the worker to select

Throws:

NotYourWorkerException - if the worker is not owned by the player

resetSelectedWorker

public void resetSelectedWorker()

Resets the worker to perform the next action to null

obtainBuildingBlocks

public void obtainBuildingBlocks(Cell selectedCell) throws IllegalActionException

Provides a list of blocks which the selected worker can build on the given cell

Specified by:

obtainBuildingBlocks in interface PlayerInterface

Parameters:

selectedCell - the cell to perform the build action on

Throws:

IllegalActionException - if the build action cannot be performed

obtainWalkableCells

public void obtainWalkableCells() throws WrongSelectionException

Provides a list of cells on which the selected player can walk to

Specified by:

obtainWalkableCells in interface PlayerInterface

Throws:

WrongSelectionException - if no worker has been selected

obtainBuildableCells

public void obtainBuildableCells() throws WrongSelectionException

Provides a list of cells on which the selected player can build on

Specified by:

obtainBuildableCells in interface PlayerInterface

Throws:

WrongSelectionException - if no worker has been selected

clonePlayer

public Player clonePlayer(Game game)

Creates a clone of this object

Parameters:

game - the current game

Returns:

a clone of this object

buildDataClass

public PlayerData buildDataClass()

Creates a PlayerData object based on this player

Returns:

this object's data class

addWorkerListener

public void addWorkerListener(AddWorkerListener addWorkerListener)

Adds a new listener

Specified by:

addWorkerListener in interface PlayerInterface

Parameters:

addWorkerListener - the listener to add to the list

addBuildableCellsListener

public void addBuildableCellsListener(BuildableCellsListener buildableCellsListener)

Adds a new listener

Specified by:

addBuildableCellsListener in interface PlayerInterface

Parameters:

buildableCellsListener - the listener to add to the list

addWalkableCellsListener

public void addWalkableCellsListener(WalkableCellsListener walkableCellsListener)

Adds a new listener

Specified by:

addWalkableCellsListener in interface PlayerInterface

Parameters:

walkableCellsListener - the listener to add to the list

addSelectWorkerListener

public void addSelectWorkerListener(SelectWorkerListener selectWorkerListener)

Adds a new listener

Specified by:

addSelectWorkerListener in interface PlayerInterface

Parameters:

selectWorkerListener - the listener to add to the list

addBuildingBlocksListener

public void addBuildingBlocksListener(BuildingBlocksListener buildingBlocksListener)

Adds a new listener

Specified by:

addBuildingBlocksListener in interface PlayerInterface

Parameters:

buildingBlocksListener - the listener to add to the list

equals

public boolean equals(java.lang.Object o)

Compares the argument to the receiver, and answers true if their names are equals

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to be

Returns:

true if the object is the same as the cell, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object