Package it.polimi.ingsw.Controller.Actions

Class MoveMotherNature

java.lang.Object

it.polimi.ingsw.Controller.Actions.PlayerAction

it.polimi.ingsw.Controller.Actions.MoveMotherNature

All Implemented Interfaces:

Serializable

public class MoveMotherNature
extends PlayerAction

This PlayerAction allows the caller to move the mother nature entity forward by a specified amount. This action is linked to the Action Phase.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final int	distanceToMove
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
MoveMotherNature(int playerBoardId, int distanceToMove)	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

distanceToMove

private final int distanceToMove

Constructor Details

MoveMotherNature

public MoveMotherNature(int playerBoardId,
 int distanceToMove)

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

Parameters:

playerBoardId - the ID of the current PlayerBoard

distanceToMove - the amount of distance Mother Nature is going 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:

• This action can be called only after having used all possible MoveStudent actions
• The previous PlayerActions must be either MoveStudent or PlayCharacterCard
• The distance declared to move must be within acceptable ranges

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)

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.