Package net.demilich.metastone.game.spells

package net.demilich.metastone.game.spells

Spells contain all the functional pieces of the card JSON (Click on description to learn more about how to use this).

Each of these classes correspond to the value part of a spell's "class" key in the card JSON. For example, if you saw the following in the card JSON:

   {
     "class": "DrawCardSpell"
   }
 

You would look up DrawCardSpell here.

Then, SpellArg referenced in the documentation correspond to keys in the JSON. For example, if you saw the following in the card JSON:

   {
     "class": "DrawCardSpell",
     "value": 1
   }
 

You'll see that DrawCardSpell says that SpellArg.VALUE is the number of cards to draw. That arg refers to the key "value" in the JSON. We refer to this change in casing as "camelCase"; each spell arg corresponds to a camelCased version in the JSON, where you remove the underscores and start the first letter lowercase, subsequent starts of words uppercase.

See Also:

• for a rough idea of what the args generally mean.
• for the base class of all spell effects (which includes stuff like battlecries).

Related Packages

Package	Description
net.demilich.metastone.game	The core engine code for Spellsource.
net.demilich.metastone.game.spells.aura	Code related to auras.
net.demilich.metastone.game.spells.custom	Custom spells that are used to implement game effects that are too complex for card JSON.
net.demilich.metastone.game.spells.desc	Subcomponents of a spell that help implement functionality like filtering cards and retrieving values.
net.demilich.metastone.game.spells.trigger	This package contains all the classes that react to game events.

Class	Description
AbstractModifyEnchantmentSpell	A base class for spells that modify the enchantments hosted by target or the target itself if it is an enchantment.
AbstractRemoveCardSpell	Indicates this effect will remove a card somehow.
ActivateEnchantmentSpell	Activates the enchantments hosted by the target or the enchantment targeted in target
ActorOrCardSpell	Simply performs SpellArg.SPELL1 if the target entity is an Actor, or SpellArg.SPELL2 if they are a Card.
AddAttributeSpell	Adds the specified SpellArg.ATTRIBUTE (Attribute) to the target.
AddBattlecrySpell	Gives the target card a OpenerDesc specified in SpellArg.BATTLECRY.
AddDeathrattleSecondaryAsTargetSpell	Gives the target the SpellArg.SPELL as a deathrattle.
AddDeathrattleSpell	Adds the deathrattle specified by the SpellArg.SPELL to the SpellArg.TARGET or target.
AddDeathrattleSpell.CardAftermathTuple
AddDescriptionSpell	Adds the SpellArg.SECONDARY_TARGET card's text to the target's description, concatenating with a space.
AddEnchantmentSpell	Adds an SpellArg.AURA (Aura) or a Enchantment (in the SpellArg.TRIGGER) to the specified target and immediately puts that aura/enchantment into play (i.e., activates it).
AddPactSpell	Adds the specified SpellArg.PACT for the specified SpellArg.TARGET_PLAYER.
AddQuestSpell	Adds the specified SpellArg.QUEST for the specified SpellArg.TARGET_PLAYER.
AddSecretSpell	Puts the specified SpellArg.SECRET (an EnchantmentDesc) into play.
AdjacentEffectSpell	Casts SpellArg.SPELL1 on the target minion, and SpellArg.SPELL2 on the minions adjacent to the target.
AuraBuffSpell	An internal spell used to implement BuffAura.
BothPlayersSpell	Indicates that the effects should occur for both players, without using the TargetPlayer.BOTH value in SpellArg.TARGET_PLAYER.
BuffHeroSpell	Deprecated. Use BuffSpell instead.
BuffSpell	Gives the target a stats boost of either *+ SpellArg.VALUE / + SpellArg.VALUE) or (+ SpellArg.ATTACK_BONUS / + SpellArg.HP_BONUS ).
CardCostModifierSpell	Creates a CardCostModifier specified by SpellArg.CARD_COST_MODIFIER that is hosted by the specified SpellArg.TARGET.
CastAfterSequenceSpell	Casts the subspell after the sequence has ended.
CastCardsSpell	Casts the specified SpellArg.CARD or the card targeted by SpellArg.SECONDARY_TARGET onto the target.
CastFromGroupSpell	Use a DiscoverSpell instead, since groups were never well thought-out anyway.
CastRandomSpellSpell	Casts a random spell from the SpellArg.CARD_SOURCE, SpellArg.CARD_FILTER and SpellArg.CARDS provided.
CastRepeatedlySpell	Casts the specified SpellArg.SPELL for SpellArg.HOW_MANY times.
CastSpellWithTargetOrElseSpell	Tries to cast the spell card (given either by SpellArg.CARD or SpellArg.SECONDARY_TARGET) onto the specified target.
ChangeHeroPowerSpell	Changes the SpellArg.TARGET_PLAYER hero power to a random hero power retrieved from SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc).
ChangeHeroSpell	Changes the hero of SpellArg.TARGET_PLAYER to the specified hero card ID in SpellArg.CARD.
ChooseAndReshuffleSpell	Prompts the player to choose among cards in their hand.
ChooseOneOptionSpell	The definition of a ChooseOneSpell's sub spells.
ChooseOneSpell	Provides a choice between SpellArg.SPELL1 and SpellArg.SPELL2, using the SpellArg.NAME and SpellArg.DESCRIPTION in those spells to generate the choice cards.
ClearOverloadSpell	Deprecated.
CloneMinionSpell	Deprecated. Use SummonSpell instead.
ComboSpell	Shorthand for a ConditionalEffectSpell that only plays the spell if the player has activated a combo (i.e., previously played a card earlier this turn).
ConditionalAttackBonusSpell	Deprecated. Use a BuffAura instead.
ConditionalEffectSpell	Casts SpellArg.SPELL1 and evaluates the SpellArg.CONDITION: if it is fulfilled, casts SpellArg.SPELL2.
ConditionalSpell	Casts the SpellArg.SPELL if the Condition in SpellArg.CONDITION is met; or, when a SpellArg.SPELLS array is specified, casts the spell in the array if its corresponding SpellArg.CONDITIONS array member is met.
CopyCardSpell	Copies a target's source card.
CopyDeathrattleSpell	Copies the target actor's deathrattles onto the source (i.e., result of EntityReference.SELF) of this spell.
CopyHeroPower	Calls ChangeHeroPowerSpell with SpellArg.CARD equal to the casting player's opponent's hero power card ID.
CreateCardSpell	Deprecated. This spell is fairly brittle and you will be better off implementing the intended effects directly.
CreateSummonSpell	Deprecated.
DamageIgnoringArmorSpell	Deals damage to the specified actor, bypassing its armor.
DamageSpell	Deals SpellArg.VALUE damage to the specified target.
DeactivateEnchantmentSpell	Deactivates the enchantments hosted by the target or deactivates the target enchantment.
DecaySpell	Deals Spellsource.DamageTypeMessage.DamageType.DECAY damage to the source.
DestroyAllExceptOneSpell	Destroys all minions except one.
DestroySecretsSpell	Destroys all the secrets belonging to SpellArg.TARGET_PLAYER.
DestroySpell	Destroys the target Actor.
DiscardCardsFromDeckSpell	Discards or removes all cards from SpellArg.TARGET_PLAYER's deck, up to SpellArg.VALUE random cards.
DiscardSpell	Discards cards from the Spellsource.ZonesMessage.Zones.HAND or from a CardSource like DeckSource which does not generate new cards (does not implement HasCardCreationSideEffects), like DeckSource.
DiscoverCardSpell	Deprecated. Use DiscoverSpell with a "spell": {"class": "ReceiveCardSpell"} instead.
DiscoverDrawSpell	Deprecated. Use DiscoverSpell instead.
DiscoverFilteredCardSpell	This class is currently only used for tri-class card discoveries.
DiscoverOptionSpell	Deprecated. The discover option spell is fairly brittle.
DiscoverRandomCardSpell	Deprecated. Use DiscoverSpell with a SpellArg.CARD_FILTER instead.
DiscoverSpell	Prompts the user to make an irreversible choice of some number of cards, and casts a spell for the chosen (and optionally, unchosen) cards.
DoubleAttackSpell	Doubles the target Actor's total attack.
DrainSpell	Deals SpellArg.VALUE damage to the target.
DrawCardAndDoSomethingSpell	Deprecated. Use a DrawCardSpell with a sub spell like {"class": "DrawCardSpell", "spell": {"class": ..., "target": "OUTPUT"}} instead.
DrawCardFromGraveyardSpell	Draws a card from the graveyard.
DrawCardSpell	Draws SpellArg.VALUE cards from the top of the player's deck.
DrawCardUntilConditionSpell	Draws cards until a condition is met.
DuelSpell	Makes each actor in SpellArg.SECONDARY_TARGET attack another random actor in SpellArg.TARGET.
EitherOrSpell	Casts SpellArg.SPELL1 if SpellArg.CONDITION is fulfilled, otherwise, casts SpellArg.SPELL2.
EnrageSpell	Implements the attack bonus portion of a complete Enrage effect.
EquipRandomWeaponSpell	Deprecated. by EquipWeaponSpell.
EquipWeaponSpell	Equips the specified weapon in SpellArg.CARD or chooses a random one based on the SpellArg.CARD_FILTER and SpellArg.CARD_SOURCE for the specified SpellArg.TARGET_PLAYER.
ExcessDamageSpell	Deals SpellArg.VALUE damage to the target and any excess to the SpellArg.SECONDARY_TARGET.
ExcessHealSpell	Performs a HealSpell effect.
FatigueSpell	Increments and deals fatigue damage to the player (SpellArg.TARGET_PLAYER).
FightSpell	Causes the source or each entity in SpellArg.SECONDARY_TARGET to GameLogic.fight(Player, Actor, Actor, PhysicalAttackAction) the target.
FirstConditionalSpell	Like ConditionalSpell, except executes the first matching condition.
ForceDeathPhaseSpell	At the moment this spell is invoked, the sequence is ended and dead entities are cleaned up from the board, triggering deathrattles.
FromDeckToHandSpell	Moves a card from the deck to the hand.
FumbleSpell	Implements "50% chance to target the wrong entity" when coupled with an appropriate trigger.
GainArmorSpell	Gives the hero of the target's owner SpellArg.VALUE armor.
GainManaSpell	Gives the player a temporary amount of SpellArg.VALUE mana.
GameValue	Used in MetaSpell and GameValueProvider to refer to specific values calculated at the time MetaSpell is evaluated.
HealingMissilesSpell	Casts healing missiles.
HealSpell	Heals the specified target for SpellArg.VALUE amount.
HeroPowerSpell	Signifies that the subspells SpellArg.SPELL, SpellArg.SPELLS, etc.) represent the "hero power effect" for cards that interact with the hero power.
InvokeOptionSpell	Casts an Invoke effect specified in SpellArg.SPELL for SpellArg.MANA mana cost.
InvokeSpell	When the player has at least Attribute.INVOKE additional unspent mana, source an extra bonus effect for that cost.
JoustSpell	A joust causes both players to show a random card satisfying the SpellArg.CARD_FILTER and performs an action if the mana cost of the caster's card is higher than the opponent's card's cost.
MetaSpell	A class that defines a collection of spells that should be executed one after another in the SpellArg.SPELLS argument.
MindControlSpell	Takes control of a target, changing its owner to the caster.
MisdirectSpell	Misdirection overrides the EntityReference.ATTACKER's current target to another random target within SpellArg.SECONDARY_TARGET.
MissilesSpell	This spell casts SpellArg.HOW_MANY missiles, each dealing SpellArg.VALUE damage (with spell damage) to random targets.
ModifyAttributeSpell	Increments (or decrements, if negative) by SpellArg.VALUE the SpellArg.ATTRIBUTE on the given target.
ModifyDamageSpell	Modifies the amount of damage that is currently about to be dealt.
ModifyDurabilitySpell	Modifies the durability of a weapon regardless of which weapon is equipped.
ModifyMaxManaSpell	Adds or destroys SpellArg.VALUE mana crystals.
ModifyWitherAttributeSpell	Gives a minion Attribute.WITHER and the appropriate trigger if it does not already have it.
MultiTargetSpell	Casts SpellArg.SPELL on a random target from the list of targets in SpellArg.TARGET at most SpellArg.VALUE times or until random targets are exhausted, whichever comes first.
NullSpell	A spell that has no effects.
OppositeEffectSpell	Acts like an AdjacentEffectSpell except on minions opposite of the target
OverkillSpell	This spell implements the new Overkill mechanic introduced in Rastakhan's Rumble.
OverrideTargetSpell	Overrides the target of the next GameLogic.targetAcquisition(Player, Entity, GameAction) call.
PlayerAttribute	Indicates a measurement about a player to use with PlayerAttributeValueProvider.
PutCopyInHandSpell	Makes SpellArg.HOW_MANY copies of the base card of the target.
PutDeckTopSpell	Puts the specified cards (target or otherwise from SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc, int)) on the top of the deck.
PutMinionOnBoardFromDeckSpell	Puts the target minion card into the Spellsource.ZonesMessage.Zones.BATTLEFIELD from the Spellsource.ZonesMessage.Zones.DECK.
PutMinionOnBoardSpell	Summons a minion from the target card onto the board in a way that counts it as being played from the hand or deck.
PutOnBottomOfDeckSpell	Puts the cards from SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc, int) on the bottom of the player's deck.
PutRandomMinionOnBoardSpell	Deprecated.
PutRandomSecretIntoPlaySpell	Takes SpellArg.HOW_MANY secret cards from the SpellArg.CARD_SOURCE (defaulting to a DeckSource) and puts those secrets directly into play without triggering a SecretPlayedTrigger.
QueryTargetSpell	Interprets the spell arguments as a query of targets and casts SpellArg.SPELL on each resulting target in order.
QuickDrawSpell	Indicates that the SpellArg.SPELL and SpellArg.SPELLS on this spell are Quick Draw effects.
RandomCardTargetSpell	Casts a spell card with random targets.
RandomlyCastSpell	Givem a list of effects in SpellArg.SPELLS, randomly choose one to cast the target.
RandomSpellTargetSpell	Deprecated. Use CastRandomSpellSpell instead.
RecastWhileSpell	Recasts the SpellArg.SPELL SpellArg.HOW_MANY times or up to 60 (14 if this is Grim Patron) by default.
ReceiveCardAndDoSomethingSpell	Deprecated. by ReceiveCardSpell, which supports sub spells in SpellArg.SPELL.
ReceiveCardSpell	Puts a card in your hand.
ReceiveLastCardSpell	Retrieves the last card from the filtered list of cards specified by SpellArg.CARD_SOURCE and SpellArg.CARD_FILTER.
RecruitSpell	Recruits (summons and removes the source card of) SpellArg.VALUE minions from SpellArg.CARD_LOCATION location.
RefreshAttacksSpell	Refreshes the target Actor's attacks, accounting for Attribute.WINDFURY.
RefreshHeroPowerSpell	Refreshes the caster's hero power so it can be used again.
RefreshManaSpell	Refreshes the player's mana by gaining an amount of mana equal to the difference in their max mana and current mana.
RelativeToTargetEffectSpell	This abstract class provides a way to cast spell effects on targets.
RemoveActorPeacefullySpell	Removes a target actor peacefully (without triggering its deathrattles) from its current zone.
RemoveAttributeSpell	Removes the SpellArg.ATTRIBUTE from the specified target.
RemoveBonusAttributes	Removes "bonus" attributes, or attributes that didn't start on the text of the minion.
RemoveCardAndDoSomethingSpell	Deprecated. Use a RemoveCardSpell with a sub spell like {"class": "RemoveCardSpell", "spell": {"class": ..., "target": "OUTPUT"}} instead.
RemoveCardSpell	Removes the target Card by putting it directly from the zone it's currently in into the Spellsource.ZonesMessage.Zones.GRAVEYARD.
RemoveEnchantmentSpell	Expires and removes SpellArg.HOW_MANY copies (default Integer.MAX_VALUE) of the enchantments whose Entity.getSourceCard() has the card ID of SpellArg.CARD from the target.
RenounceClassSpell	Deprecated. Has no implementation.
ReplaceCardLocationSpell	Deprecated. Use ReplaceCardsSpell instead.
ReplaceCardsSpell	Replaces the target with one of the cards from SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc, int).
ReservoirSpell	Shorthand for a ConditionalEffectSpell that only plays the conditional (second) spell if the caster's deck has a number of cards greater than or equal to the SpellArg.VALUE.
ResetDeckSpell	Sets the deck to its initial state at the start of the game.
ResurrectFromBothSpell	Resurrects minions from both player's graveyards.
ResurrectSpell	Resurrects minions from the caster's graveyard.
ReturnMinionToHandSpell	Deprecated. Use ReturnTargetToHandSpell instead.
ReturnTargetToHandSpell	Returns the target to the player's hand as a card.
ReturnToHandWithEnchantmentsSpell	Returns the target to the hand, keeping its enchantments.
RevealCardSpell	Reveals a card from a filter, SpellArg.CARD or the target if neither is specified.
RevertableSpell	This spell is the base class for spells that can be undone by a SpellArg.REVERT_TRIGGER or SpellArg.SECOND_REVERT_TRIGGER.
ReviveMinionSpell	Reviving a minion, unlike resurrecting it, puts a minion back into the position on the board where it died.
RoastSpell	Roasting a card removes the card from the top of the deck and adds the Attribute.ROASTED to it.
SetAttackerSpell	During a TargetAcquisitionEvent or a PhysicalAttackEvent firing, changes the EntityReference.ATTACKER to the specified target.
SetAttackSpell	Sets the target's attack-related attributes such that the result of Actor.getAttack() or Card.getAttack() is equal to the SpellArg.VALUE.
SetAttributeSpell	Sets the target's SpellArg.ATTRIBUTE to the specified SpellArg.VALUE.
SetCardSpell	Sets the target Card's Attribute.CARD_ID or Attribute.AURA_CARD_ID to the card ID specified in SpellArg.CARD.
SetDescriptionSpell	Sets the target entity's Attribute.DESCRIPTION to the string specified in SpellArg.DESCRIPTION, or clears it if no description is specified.
SetHeroHpSpell	Deprecated.
SetHpSpell	Sets the Actor or Card's hitpoints to the specified SpellArg.VALUE, overriding any existing bonuses stored in Attribute.HP_BONUS.
SetMaxManaSpell	Sets a player's max mana to the given SpellArg.VALUE
SetRaceSpell	Sets the target's Race to the SpellArg.RACE value.
ShuffleMinionToDeckSpell	Peacefully removes the target minion and shuffles it into the caster's deck.
ShuffleOriginalToDeckSpell	Shuffles a card directly into the deck, not its copy.
ShuffleToDeckSpell	Shuffles copies of the specified target or SpellArg.CARD_SOURCE & SpellArg.CARD_FILTER cards into the deck.
ShuffleToDeckWithEnchantmentsSpell	Shuffles the target Spellsource.EntityTypeMessage.EntityType.MINION into the player's deck with the enchantments
SilenceSpell	Silences the specified Actor.
SortDeckByManaCostSpell	Sorts a deck by mana costs, putting the lowest cost cards on top.
Spell	The base class for "spells," or collections of effects in the engine.
SpellUtils	A set of utilities to help write spells.
SpellUtils.DetermineCastingPlayer	An object that contains results of a SpellUtils.determineCastingPlayer(GameContext, Player, Entity, TargetPlayer) call.
SplashDamageSpell	Like a DamageSpell, except the source of the damage is changed to the EntityReference.EVENT_SOURCE.
StealCardSpell	Steals the target card and moves it to the caster's zone from SpellArg.CARD_LOCATION.
StealHealthSpell	Steals SpellArg.HP_BONUS health from the target actor and gives it to the source.
StealRandomSecretSpell	Steals a random secret belonging to the opponent of SpellArg.TARGET_PLAYER.
SummonCardFromAttributeSpell	Reads a card ID from the specified attribute SpellArg.ATTRIBUTE.
SummonSpell	Summons minions specified by cards; summons random minions from card filters; or copies minions according to targets.
SupremacySpell	Indicates that the subspells should be cast as the "Supremacy" effect.
SwapAttackAndHpSpell	Swaps the target's attack and hitpoints, making the target's hitpoints its attack value and vice versa.
SwapAttackSpell	Swaps the target's attack with the source actor's attack.
SwapCardsSpell	Swaps the card pointed to by SpellArg.SECONDARY_TARGET with the target Card.
SwapHpSpell	Swaps the target's hitpoints with the source actor's hitpoints.
SwapMinionSpell	Swaps the minion specified by SpellArg.SECONDARY_TARGET with the target.
SwipeSpell	Deals SpellArg.VALUE damage to the target and SpellArg.SECONDARY_VALUE damage to the SpellArg.SECONDARY_TARGET actors.
TargetPlayer	Indicates a player reference.
TargetToSourceSecondaryToTargetSpell	Puts the target that's passed into this spell as the sub spell's source.
TemporaryAttackSpell	Gives the target actor SpellArg.VALUE bonus attack until the end of the current turn.
TransformCardSpell	Transforms a target card to the specified SpellArg.CARD by removing the old card and receiving a new one.
TransformMinionSpell	Transforms the target minion into the SpellArg.CARD or the source card of the entity pointed to by SpellArg.SECONDARY_TARGET.
TransformToRandomMinionSpell	Transforms the target into a random base minion from SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc, int).
TriggerDeathrattleSpell	Triggers the target entity's aftermaths.
TriggerOpenerSpell	Triggers the opener written on each target entity with random targets (except itself).
TriggerQuickDrawSpell	Triggers the Quick Draw effect wrapped by the QuickDrawSpell written on the target.
TriggerSecretSpell	Triggers a specific secret, either from the SpellArg.CARD if specified or the target card.
UseHeroPowerSpell	Uses the SpellArg.TARGET_PLAYER's hero power, choosing a target randomly.
ValueToHowManySpell	Decorates a SpellArg.SPELL, turning a SpellArg.VALUE into a SpellArg.HOW_MANY on the sub-spell.
WeaponDamageSpell	Deals magical damage from the weapon equipped by the player (SpellArg.TARGET_PLAYER), correctly accounting for effects like Attribute.LIFESTEAL and Attribute.POISONOUS.
WhereverTheyAreSpell	Casts a spell on a target and its copies "wherever they are" in the player (casting player's) zones.
WitherSpell	Reduces the attack of the target by the source entity's Attribute.WITHER value.