Class ShuffleToDeckSpell

java.lang.Object
net.demilich.metastone.game.spells.Spell
net.demilich.metastone.game.spells.ShuffleToDeckSpell
All Implemented Interfaces:
Serializable, HasDesc<SpellDesc>
Direct Known Subclasses:
ShuffleMinionToDeckSpell, ShuffleOriginalToDeckSpell

public class ShuffleToDeckSpell extends Spell
Shuffles copies of the specified target or SpellArg.CARD_SOURCE & SpellArg.CARD_FILTER cards into the deck. Creates SpellArg.HOW_MANY copies (default is 1).

When SpellArg.EXCLUSIVE is true, marks the shuffled card as an extra copy for the purposes of the ShuffledTrigger. To trigger only on non-extra copies, use ShuffledOnlyOriginalCopiesTrigger.

Shuffling cards to the deck when generated from a HasCardCreationSideEffects card source is done without replacement.

For example, this shuffles 3 Mur'Ghouls into the caster's deck:

   {
     "class": "ShuffleToDeckSpell",
     "card": "token_mur'ghoul",
     "howMany": 3,
     "targetPlayer": "SELF"
   }
 
See Also:
  • Constructor Details

    • ShuffleToDeckSpell

      public ShuffleToDeckSpell()
  • Method Details

    • create

      public static SpellDesc create(String card)
    • onCast

      protected void onCast(GameContext context, Player player, SpellDesc desc, Entity source, Entity target)
      Description copied from class: Spell
      Implementations of onCast are the meat-and-bones of a spell's effects. This should actually call a variety of methods in GameLogic, generate cards using SpellUtils.getCards(GameContext, Player, Entity, Entity, SpellDesc), interpret SpellArg keys in the desc, etc.

      Observe that subclasses of Spell mostly just need to implement this function. Also, observe that instances of Spell are stateless: all the state is provided as arguments to this function.

      Specified by:
      onCast in class Spell
      Parameters:
      context - The game context
      player - The casting player
      desc - The collection of SpellArg keys and values that are interpreted by the implementation of this function to actually cause effects in a game
      source - The entity from which this effect is happening (typically a card or a minion if it's a battlecry).
      target - The particular target of this invocation of the spell. When a spell hits multiple targets, like an AoE damage effect, this method is called once for each target in the list of targets.
      See Also:
    • shuffle

      protected Card shuffle(GameContext context, Player player, Entity source, Entity targetEntity, Card targetCard, boolean extraCopy, int sourcePlayerId)