Package it.polimi.ingsw.Controller.Actions

Class MoveStudent

java.lang.Object

it.polimi.ingsw.Controller.Actions.PlayerAction

it.polimi.ingsw.Controller.Actions.MoveStudent

All Implemented Interfaces:

Serializable

public class MoveStudent
extends PlayerAction

This PlayerAction allows the caller to move a single student from the entrance to the school to an island or a dining room table. This action is linked to the Action Phase.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final MoveDestination	destination
private final int	selectedEntrancePosition
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
MoveStudent(int playerBoardId, int selectedEntrancePosition, MoveDestination destination)	Create a new instance of this class with the following inputs:

Method Summary

Modifier and Type	Method	Description
protected OptionalValue<InputValidationException>	customValidation(List<PlayerAction> history, Model ctx)	This function is used by PlayerAction.validate(List, Model) to check whether or not the declared PlayerAction is possible. This function will check for the following requirements:
void	unsafeExecute(Model ctx)	Every class extending PlayerAction must implement the following method, which takes a Model reference and applies the concrete effect of the action.

Methods inherited from class it.polimi.ingsw.Controller.Actions.PlayerAction

getPlayerBoardID, validate

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

selectedEntrancePosition

private final int selectedEntrancePosition

destination

private final MoveDestination destination

Constructor Details

MoveStudent

public MoveStudent(int playerBoardId,
 int selectedEntrancePosition,
 MoveDestination destination)

Create a new instance of this class with the following inputs:

Parameters:

playerBoardId - the ID of the current PlayerBoard

destination - a MoveDestination value specifying where the selected student will be moved

selectedEntrancePosition - id of the slot in the list returned by PlayerBoard.getEntranceStudents(), selects a student to be moved

Method Details

customValidation

protected OptionalValue<InputValidationException> customValidation(List<PlayerAction> history,
 Model ctx)

This function is used by PlayerAction.validate(List, Model) to check whether or not the declared PlayerAction is possible.
This function will check for the following requirements:

• The GamePhase must be GamePhase.ACTION
• The previous PlayerActions must be either MoveStudent or PlayCharacterCard or the history must be empty
• Only a limited number of actions like this one can be played (3 or 4 depending on the players)
• The student decleared to move must be part of the entrance on the PlayerBoard
• If the destination is DestinationType.ISLAND then the island ID must be within bounds (0 to 12 excluded)
• If the destination is DestinationType.DININGROOM then the dining room must be able to contain the pawn

Specified by:

customValidation in class PlayerAction

Parameters:

history - the controller stores a List of previous PlayerActions related to the player taking the current turn (at every new turn, the history is cleared). Some actions may use this List to check for duplicates.

ctx - a reference to Model. Some actions may use this reference to check for consistency between what the actions declares and what the Model offers.

Returns:

An empty OptionalValue in case of a successful validation. Otherwise the returned OptionalValue contains the related InputValidationException

unsafeExecute

public void unsafeExecute(Model ctx)
                   throws Exception

Description copied from class: PlayerAction

Every class extending PlayerAction must implement the following method, which takes a Model reference and applies the concrete effect of the action.
Warning: this function, as implied by the name, is unsafe. it should never be called by called outside the scope of the class Controller, which takes adequate precautions in order to guarantee a coherent execution of the method.

Specified by:

unsafeExecute in class PlayerAction

Parameters:

ctx - the Model reference, once the method finishes running the game state will be altered.

Throws:

Exception - Should an error occur during the execution of the method, such error will be reported through the thrown Exception. Note that any PlayerAction inheritor should guarantee the absence of Exceptions for any positive return value yielded by PlayerAction.validate(List, Model)