Package net.demilich.metastone.game.actions

Class DiscoverAction

java.lang.Object

net.demilich.metastone.game.actions.GameAction

net.demilich.metastone.game.actions.DiscoverAction

All Implemented Interfaces:

Serializable, Cloneable, HasCard, Notification

public class DiscoverAction
extends GameAction
implements HasCard

A DiscoverAction is a card and spell tuple that corresponds to a particular card selected by the player and the spell that will take that card as an argument.

Typically, discover actions have a ReceiveCardSpell that puts the card in getCard() into the player's hand. But any kind of spell that takes a SpellArg.CARD argument will work with a DiscoverAction.

Discover cards should never be executed directly. They are presented to the Behaviour in GameLogic.requestAction(Player, List), so they will always be some kind of "recursive" call inside a Behaviour.

See Also:

• Serialized Form

Field Summary

Fields inherited from class net.demilich.metastone.game.actions.GameAction

chooseOneOptionIndex

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DiscoverAction(@NotNull SpellDesc spell)

Method Summary

Modifier and Type	Method	Description
final boolean	canBeExecutedOn(GameContext context, Player player, Entity entity)	Some discover actions cannot be called on certain kinds of cards.
DiscoverAction	clone()
static DiscoverAction	createDiscover(@NotNull SpellDesc spell)	Creates a discover action from the given spell description.
boolean	equals(Object o)
void	execute(GameContext context, int playerId)	The implementation of this method actually represents the game effects of this action.
Card	getCard()	Gets a reference to the card this discover action corresponds to.
String	getDescription(GameContext context, int playerId)	A user-renderable description of what occurred in this notification.
Entity	getSource(GameContext context)
Card	getSourceCard()
@NotNull SpellDesc	getSpell()
List<Entity>	getTargets(GameContext context, int player)	For visualization purposes, what are the targets of this notification?
int	hashCode()
void	setCard(Card card)
String	toString()

Methods inherited from class net.demilich.metastone.game.actions.GameAction

getActionType, getChooseOneOptionIndex, getId, getSource, getSourceReference, getTargetReference, getTargetRequirement, isClientInterested, isOverrideChild, isPowerHistory, setActionType, setChooseOneOptionIndex, setId, setOverrideChild, setSourceReference, setTarget, setTargetReference, setTargetRequirement, withTargetReference

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DiscoverAction

protected DiscoverAction(@NotNull
 @NotNull SpellDesc spell)

Method Details

createDiscover

public static DiscoverAction createDiscover(@NotNull
 @NotNull SpellDesc spell)

Creates a discover action from the given spell description.

Parameters:

spell - A spell that takes SpellArg.CARD as an argument.

Returns:

A DiscoverAction.

clone

public DiscoverAction clone()

Overrides:

clone in class GameAction

canBeExecutedOn

public final boolean canBeExecutedOn(GameContext context,
 Player player,
 Entity entity)

Some discover actions cannot be called on certain kinds of cards. This is not currently used because DiscoverActions are not unrolled in ActionLogic.rollout(GameAction, GameContext, Player, Collection).

Overrides:

canBeExecutedOn in class GameAction

Parameters:

context - The context

player - The player

entity - The entity to test

Returns:

true if the discover action can be called on a particular entity.

execute

public void execute(GameContext context,
 int playerId)

Description copied from class: GameAction

The implementation of this method actually represents the game effects of this action.

For example, the PlayMinionCardAction eventually calls GameLogic.summon(int, Minion, Entity, int, boolean).

Specified by:

execute in class GameAction

Parameters:

context - The game context

playerId - The invoking player

See Also:

• for an important implementation for playing cards.

getCard

public Card getCard()

Gets a reference to the card this discover action corresponds to.

Returns:

The card.

getSource

public Entity getSource(GameContext context)

Specified by:

getSource in interface Notification

Overrides:

getSource in class GameAction

getTargets

public List<Entity> getTargets(GameContext context,
 int player)

Description copied from interface: Notification

For visualization purposes, what are the targets of this notification?

Specified by:

getTargets in interface Notification

Overrides:

getTargets in class GameAction

Parameters:

context - game context

player - the player

Returns:

A reference to the entity that is the visualizable target of this notification.

getDescription

public String getDescription(GameContext context,
 int playerId)

Description copied from interface: Notification

A user-renderable description of what occurred in this notification.

Specified by:

getDescription in interface Notification

Overrides:

getDescription in class GameAction

Parameters:

context - the game context

playerId - the player ID

Returns:

a description string

getSpell

@NotNull
public @NotNull SpellDesc getSpell()

setCard

public void setCard(Card card)

toString

public String toString()

Overrides:

toString in class GameAction

equals

public boolean equals(Object o)

Overrides:

equals in class GameAction

hashCode

public int hashCode()

Overrides:

hashCode in class GameAction

getSourceCard

public Card getSourceCard()

Specified by:

getSourceCard in interface HasCard