Package net.demilich.metastone.game.cards.costmodifier

Class CardCostModifier

java.lang.Object

net.demilich.metastone.game.logic.CustomCloneable

net.demilich.metastone.game.entities.Entity

net.demilich.metastone.game.spells.trigger.Enchantment

net.demilich.metastone.game.cards.costmodifier.CardCostModifier

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Entity>, HasDesc<CardCostModifierDesc>, HasCard, Trigger

Direct Known Subclasses:

OneTurnCostModifier, ToggleCostModifier

public class CardCostModifier
extends Enchantment
implements HasDesc<CardCostModifierDesc>

A card cost modifier.

In this example, the specified modifier reduces the hosting entity's cost by one.

     {
         "class": "CardCostModifier",
         "target": "SELF",
         "operation": "SUBTRACT",
         "value": 1
     }
 

When a target isn't specified, the card cost modification applies to the hand of the owner of this card cost modifier (i.e. EntityReference.FRIENDLY_HAND.

To make a card cost modifier apply to both player's hands during both player's turns, CardCostModifierArg.TARGET_PLAYER must be TargetPlayer.BOTH and the target should be EntityReference.BOTH_HANDS.

See Also:

• for a spell that can put CardCostModifier effects into play.
• for a list of arguments for card cost modification.
• Serialized Form

Field Summary

Fields inherited from class net.demilich.metastone.game.spells.trigger.Enchantment

activated, activationTriggers, added, copyToActor, countByValue, countUntilCast, expirationTriggers, expired, firesThisSequence, hostReference, keepAfterTransform, maxFiresPerSequence, oneTurn, persistentOwner, spell, triggers, usesSpellTrigger, zones

Fields inherited from class net.demilich.metastone.game.entities.Entity

attributes, effectSource, entityLocation, name, NO_OWNER, sourceCard

Constructor Summary

Constructors

Constructor	Description
CardCostModifier(CardCostModifierDesc desc)

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(GameContext context, Card card, Player player)	Determines whether this modifier applies to the specified card.
protected void	cast(int ownerId, SpellDesc spell, GameEvent event)
CardCostModifier	clone()	Clone an entity, including its ID and location.
protected Object	get(CardCostModifierArg arg)	Returns the value of the specified CardCostModifierArg
protected com.hiddenswitch.spellsource.rpc.Spellsource.CardTypeMessage.CardType	getCardType()
protected EventTriggerDesc[]	getDefaultTriggers()
protected com.hiddenswitch.spellsource.rpc.Spellsource.ZonesMessage.Zones[]	getDefaultZones()
CardCostModifierDesc	getDesc()
protected EntityFilter	getFilter()	Gets the filter to apply to the CardCostModifierArg.TARGET.
int	getMinValue()
protected Attribute	getRequiredAttribute()
protected String	getRequiredRace()
TargetPlayer	getTargetPlayer()	Gets the target player of the given card cost modifier.
boolean	isPersistentOwner()	Indicates this trigger cannot change owners.
void	onAdd(GameContext context, Player player, Entity source, Entity host)	Called when the trigger is added into a GameContext's state.
int	process(GameContext context, Entity host, Card card, int currentManaCost, Player player)
void	setDesc(Desc<?,?> desc)
protected boolean	shouldNotifyEnchantmentFired(GameEvent event)
boolean	targetsSelf()

Methods inherited from class net.demilich.metastone.game.spells.trigger.Enchantment

activate, endOfSequence, expire, fires, getActivationTriggers, getCopy, getCountUntilCast, getDefaultBattlefieldZones, getDefaultBattlefieldZonesSet, getDefaultDeckZones, getDefaultGameZones, getDefaultPassiveZones, getEntityType, getEntrySet, getExpirationTriggers, getFires, getHostReference, getMaxFires, getMaxFiresPerSequence, getOneTurn, getSourceCard, getSpell, getTriggers, getUsesSpellTrigger, getZones, innerQueues, interestedIn, isActivated, isCopyToActor, isCountByValue, isExpired, isKeptAfterTransform, oneTurnOnly, onGameEvent, process, queues, setActivated, setActivationTriggers, setCopyToActor, setCountByValue, setCountUntilCast, setExpirationTriggers, setFires, setHostReference, setKeepAfterTransform, setMaxFires, setMaxFiresPerSequence, setOneTurn, setPersistentOwner, setSpell, setTriggers, setUsesSpellTrigger, setZones, toString

Methods inherited from class net.demilich.metastone.game.entities.Entity

compareTo, diedOnBattlefield, evaluateDescriptions, getAttribute, getAttributes, getAttributeValue, getAttributeValue, getCardInventoryId, getCopySource, getDescription, getDescription, getDynamicDescription, getEffectSource, getEntityLocation, getGameTriggers, getId, getIndex, getMaxNumberOfAttacks, getName, getOwner, getRace, getReference, getUserId, getZone, hasAttribute, hasPersistentEffects, isDestroyed, isInPlay, isRemovedPeacefully, modifyAttribute, modifyHpBonus, moveOrAddTo, moveOrAddTo, resetEntityLocations, setAttribute, setAttribute, setAttribute, setDescription, setEffectSource, setEntityLocation, setId, setName, setOwner, setSourceCard, setUserId, transformResolved, transformResolved

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.demilich.metastone.game.spells.trigger.Trigger

getOwner, setOwner

Constructor Details

CardCostModifier

public CardCostModifier(CardCostModifierDesc desc)

Method Details

appliesTo

public boolean appliesTo(GameContext context,
 Card card,
 Player player)

Determines whether this modifier applies to the specified card.

First, the method checks if the modifier has been Enchantment.expired due to its CardCostModifierArg.EXPIRATION_TRIGGER. For a OneTurnCostModifier, the expiration trigger is assumed to be a TurnEndTrigger.

Then, the modifier evaluates its CardCostModifierArg.TARGET and CardCostModifierArg.FILTER and sees if the card is equal to or is contained within the resulting set of Entity objects. When not specified, the CardCostModifierArg.TARGET is assumed to be the EntityReference.FRIENDLY_HAND.

The CardCostModifierArg.RACE argument, if specified, is compared to the card instance's Card.getRace().

The CardCostModifierArg.CARD_TYPE argument, if specified, is compared to the card instance's Card.getCardType().

Finally, the CardCostModifierArg.TARGET_PLAYER argument, if specified, is compared to the card instance's Entity.getOwner() with respect to the Enchantment.getHostReference() of this modifier. For example, if CardCostModifierArg.TARGET_PLAYER is TargetPlayer.SELF, then the card's Entity.getOwner() is compared to the Enchantment.getHostReference() Entity.getOwner().

Parameters:

context - The game context.

card - The card to evaluate.

player - The player from whose point of view this should be evaluated.

Returns:

true if the modifier applies to this card.

get

protected Object get(CardCostModifierArg arg)

Returns the value of the specified CardCostModifierArg

Parameters:

arg - The argument

Returns:

The value

getFilter

protected EntityFilter getFilter()

Gets the filter to apply to the CardCostModifierArg.TARGET.

Returns:

An EntityFilter

See Also:

• to read more on how application is determined.

getCardType

protected com.hiddenswitch.spellsource.rpc.Spellsource.CardTypeMessage.CardType getCardType()

getMinValue

public int getMinValue()

getRequiredAttribute

protected Attribute getRequiredAttribute()

getRequiredRace

protected String getRequiredRace()

getTargetPlayer

public TargetPlayer getTargetPlayer()

Gets the target player of the given card cost modifier.

This is relative to the owner of the modifier, which is typically the caster, not the owner of the Enchantment.getHostReference().

Returns:

TargetPlayer.SELF if not specified, otherwise the TargetPlayer specified by the modifier.

onAdd

public void onAdd(GameContext context,
 Player player,
 Entity source,
 Entity host)

Description copied from interface: Trigger

Called when the trigger is added into a GameContext's state.

Specified by:

onAdd in interface Trigger

Overrides:

onAdd in class Enchantment

Parameters:

context - The game context.

process

public int process(GameContext context,
 Entity host,
 Card card,
 int currentManaCost,
 Player player)

isPersistentOwner

public boolean isPersistentOwner()

Description copied from interface: Trigger

Indicates this trigger cannot change owners. For example, a Secret does not have a persistent owner, because card texts can steal secrets. However, the trigger described by Blessing of Wisdom does have a persistent owner, since the casting player of that spell should always draw the card it receives.

Specified by:

isPersistentOwner in interface Trigger

Overrides:

isPersistentOwner in class Enchantment

Returns:

true if the trigger's Trigger.onGameEvent(GameEvent) should be evaluated from the point of view of the owner when the trigger was created, as opposed to what the owner is right now (which may have changed).

targetsSelf

public boolean targetsSelf()

getDesc

public CardCostModifierDesc getDesc()

Specified by:

getDesc in interface HasDesc<CardCostModifierDesc>

setDesc

public void setDesc(Desc<?,?> desc)

Specified by:

setDesc in interface HasDesc<CardCostModifierDesc>

getDefaultTriggers

protected EventTriggerDesc[] getDefaultTriggers()

Overrides:

getDefaultTriggers in class Enchantment

clone

public CardCostModifier clone()

Description copied from class: Entity

Clone an entity, including its ID and location.

Use this method for emulating an "immutable" view on an entity. This kind of cloning is not suitable for most gameplay situations, because using the clone will cause two entities with identical IDs and locations to exist. Instead, a subclass will provide a getCopy() method that is more helpful for gameplay.

Specified by:

clone in interface Trigger

Overrides:

clone in class Enchantment

Returns:

An exact clone.

cast

protected void cast(int ownerId,
 SpellDesc spell,
 GameEvent event)

Overrides:

cast in class Enchantment

getDefaultZones

protected com.hiddenswitch.spellsource.rpc.Spellsource.ZonesMessage.Zones[] getDefaultZones()

Overrides:

getDefaultZones in class Enchantment

shouldNotifyEnchantmentFired

protected boolean shouldNotifyEnchantmentFired(GameEvent event)

Overrides:

shouldNotifyEnchantmentFired in class Enchantment