Class RecruitSpell

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

public class RecruitSpell extends Spell
Recruits (summons and removes the source card of) SpellArg.VALUE minions from SpellArg.CARD_LOCATION location.

If a SpellArg.SPELL is specified, it is cast on the minion after it is summoned.

The card is moved to the Spellsource.ZonesMessage.Zones.SET_ASIDE_ZONE before the minion printed on it is summoned. This prevents enchantments from being cleared.

Playing cards this way does not count as playing them from the hand or deck.

For example, to do the text "Recruit 2 minions that cost (4) or less:"

   {
     "class": "RecruitSpell",
     "value": 2,
     "cardFilter": {
       "class": "AndFilter",
       "filters": [
         {
           "class": "CardFilter",
           "cardType": "MINION"
         },
         {
           "class": "ManaCostFilter",
           "value": 4,
           "operation": "LESS_OR_EQUAL"
         }
       ]
     },
     "cardLocation": "DECK",
     "targetPlayer": "SELF"
   }
 
For the text "Recruit two 1-Cost minions," observe that the card means base mana cost. The only change is the filter:
   {
     "class": "RecruitSpell",
     "value": 2,
     "cardFilter": {
       "class": "CardFilter",
       "cardType": "MINION",
       "manaCost": 1
     },
     "cardLocation": "DECK",
     "targetPlayer": "SELF"
   }
 

To recruit a specific target from the hand, use PutMinionOnBoardSpell. If you need to only put the minion onto the board if it is in the deck, use PutMinionOnBoardFromDeckSpell.

See Also:
  • Constructor Details

    • RecruitSpell

      public RecruitSpell()
  • Method Details

    • 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: