Package it.polimi.ingsw.Controller.Actions

Class PlayCharacterCard

java.lang.Object

it.polimi.ingsw.Controller.Actions.PlayerAction

it.polimi.ingsw.Controller.Actions.PlayCharacterCard

All Implemented Interfaces:

Serializable

public class PlayCharacterCard
extends PlayerAction

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final OptionalValue<Integer>	optTargetIsland
private final OptionalValue<PawnColour>	optTargetPawn
private final OptionalValue<List<Pair<PawnColour,PawnColour>>>	optTargetPawnPairs
private final int	selectedCard
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
PlayCharacterCard(int playerBoardId, int selectedCard, OptionalValue<Integer> optTargetIsland, OptionalValue<PawnColour> optTargetPawn, OptionalValue<List<Pair<PawnColour,PawnColour>>> optTargetPawnPairs)	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:
private CharacterCardInput	generateCharacterCardInput(PlayerBoard caller, Model ctx)	a CharacterCard requires more information than the one contained in the constructor of this PlayerAction to be able to function.
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

selectedCard

private final int selectedCard

optTargetIsland

private final OptionalValue<Integer> optTargetIsland

optTargetPawn

private final OptionalValue<PawnColour> optTargetPawn

optTargetPawnPairs

private final OptionalValue<List<Pair<PawnColour,PawnColour>>> optTargetPawnPairs

Constructor Details

PlayCharacterCard

public PlayCharacterCard(int playerBoardId,
 int selectedCard,
 OptionalValue<Integer> optTargetIsland,
 OptionalValue<PawnColour> optTargetPawn,
 OptionalValue<List<Pair<PawnColour,PawnColour>>> optTargetPawnPairs)

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

Parameters:

playerBoardId - the ID of the current PlayerBoard

selectedCard - the ID of the CharacterCard to be played

optTargetIsland - if a target island is required as an input to the card, provide it here

optTargetPawn - if a target pawn is required as an input to the card, provide it here

optTargetPawnPairs - if a list of pawn pairs is required as an input to the card, provide it here

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 GameMode must be GameMode.ADVANCED
• The GamePhase must be GamePhase.ACTION
• The selected character card must be within bounds (index 0 to 2 included)
• The player needs to have enough coins to by the card
• The CharacterCardInput generated from the attributes must be correct

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)

generateCharacterCardInput

private CharacterCardInput generateCharacterCardInput(PlayerBoard caller,
 Model ctx)
                                               throws InvalidContainerIndexException

a CharacterCard requires more information than the one contained in the constructor of this PlayerAction to be able to function. During the calls to verify the action, a CharacterCardInput object needs to be created so the internal validation mechanism of the CharacterCard can work.

Parameters:

caller - instead of the id of the current player, a reference to the current PlayerBoard is needed

ctx - the Model object is required to allow translation of the attributes of this object into a CharacterCardInput

Returns:

the CharacterCardInput associated with this object's attributes

Throws:

InvalidContainerIndexException - if the attribute of target island is pointing to an unidentified island-ID in the model, this exception is thrown