Class SetDescriptionSpell

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

public class SetDescriptionSpell extends Spell
Sets the target entity's Attribute.DESCRIPTION to the string specified in SpellArg.DESCRIPTION, or clears it if no description is specified.

For example:

     {
         "class": "SetDescriptionSpell",
         "target": "SELF",
         "description": "New description."
     }
 
This is used by The Darkness to toggle the explanation written on its card form versus its permanent form.
See Also:
  • Constructor Details

    • SetDescriptionSpell

      public SetDescriptionSpell()
  • Method Details

    • create

      public static SpellDesc create(String description)
    • 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: