Package net.demilich.metastone.game.spells

Class AddPactSpell

java.lang.Object

net.demilich.metastone.game.spells.Spell

net.demilich.metastone.game.spells.AddQuestSpell

net.demilich.metastone.game.spells.AddPactSpell

All Implemented Interfaces:

Serializable, HasDesc<SpellDesc>

public class AddPactSpell
extends AddQuestSpell

Adds the specified SpellArg.PACT for the specified SpellArg.TARGET_PLAYER.

A pact is a permanent that triggers its written effect when either player performs the action written on the card. Their EnchantmentDescArg.EVENT_TRIGGER event trigger should have EventTriggerArg.TARGET_PLAYER set to TargetPlayer.BOTH.

For example, a spell may create a pact for both players that reads, "After your characters have been damaged 10 times, lose the game."

     {
         "class": "AddQuestSpell",
         "targetPlayer": "BOTH",
         "pact": {
              "countUntilCast": 10,
              "eventTrigger": {
                  "class": "DamageReceivedTrigger",
                  "targetPlayer": "BOTH"
              },
              "spell": {
                  "class": "DestroySpell",
                  "target": "FRIENDLY_HERO"
              },
              "maxFires": 10
          }
     }
 

See Also:

• for more about quests and the format for specifying them.
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AddPactSpell()

Method Summary

Modifier and Type	Method	Description
static SpellDesc	create(TargetPlayer target, Quest pact)	Creates this spell for the specified TargetPlayer and Quest.
static SpellDesc	create(Quest quest)	Creates this spell for the casting player and the specified Quest.
protected void	onCast(GameContext context, Player player, SpellDesc desc, Entity source, Entity target)	Implementations of onCast are the meat-and-bones of a spell's effects.

Methods inherited from class net.demilich.metastone.game.spells.Spell

cast, castForPlayer, checkArguments, getDesc, isNativeStateful, setDesc, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AddPactSpell

public AddPactSpell()

Method Details

create

public static SpellDesc create(Quest quest)

Creates this spell for the casting player and the specified Quest.

Parameters:

quest - The quest object to use for this spell.

Returns:

The spell

create

public static SpellDesc create(TargetPlayer target,
 Quest pact)

Creates this spell for the specified TargetPlayer and Quest.

Parameters:

target - The TargetPlayer interpreted from the caster's point of view.

pact - The pact.

Returns:

The spell

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 AddQuestSpell

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:

• for an example of a complex spell implementation.