Class AddAttributeSpell

All Implemented Interfaces:
Serializable, HasDesc<SpellDesc>

public class AddAttributeSpell extends RevertableSpell
Adds the specified SpellArg.ATTRIBUTE (Attribute) to the target.

If a SpellArg.REVERT_TRIGGER is specified, calls the RemoveAttributeSpell on the target when the trigger fires.

For example, to give all friendly minions stealth until the start of the player's next turn:

 {
  "class": "AddAttributeSpell",
  "target": "FRIENDLY_MINIONS",
  "attribute": "STEALTH",
    "filter": {
      "class": "AttributeFilter",
      "attribute": "STEALTH",
      "invert": true,
      "operation": "HAS"
    },
    "revertTrigger": {
    "class": "TurnStartTrigger",
    "targetPlayer": "SELF"
  }
 }
 
See Also:
  • Constructor Details

    • AddAttributeSpell

      public AddAttributeSpell()
  • Method Details

    • create

      public static SpellDesc create(Attribute tag)
      Creates an instance of this spell without a target specified.
      Parameters:
      tag - The Attribute to set.
      Returns:
      A spell instance
    • create

      public static SpellDesc create(Attribute tag, EventTrigger revertTrigger)
      Creates an instance of this spell with the specified attribute and a revert trigger
      Parameters:
      tag - The attribute
      revertTrigger - The trigger that, when fired, will revert this attribute
      Returns:
      A spell instance
    • create

      public static SpellDesc create(EntityReference target, Attribute tag)
      Creates an instance of this spell targeting the specified target
      Parameters:
      target - The target
      tag - The attribute
      Returns:
      A spell instance
    • create

      public static SpellDesc create(EntityReference target, Attribute tag, EventTrigger revertTrigger)
      Creates an instance of this spell with the specified target, attribute and revert trigger
      Parameters:
      target - The target
      tag - The attribute to add to the target
      revertTrigger - The trigger that, when fired, will revert this attribute
      Returns:
      A spell instance
    • getReverseSpell

      protected SpellDesc getReverseSpell(GameContext context, Player player, Entity source, SpellDesc desc, EntityReference target)
      Specified by:
      getReverseSpell in class RevertableSpell
    • 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.

      Overrides:
      onCast in class RevertableSpell
      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: