Package net.demilich.metastone.game.spells

Class FightSpell

java.lang.Object

net.demilich.metastone.game.spells.Spell

net.demilich.metastone.game.spells.FightSpell

All Implemented Interfaces:

Serializable, HasDesc<SpellDesc>

Direct Known Subclasses:

DuelSpell, FightRandomAdjacentMinionSpell

public class FightSpell
extends Spell

Causes the source or each entity in SpellArg.SECONDARY_TARGET to GameLogic.fight(Player, Actor, Actor, PhysicalAttackAction) the target.

Activates the hero's weapon regardless of whose turn it is if a Hero is an attacker.

After the attack occurs, casts the SpellArg.SPELL sub-spell with the source as the source of this spell cast, the target as the defender, and the EntityReference.OUTPUT set to the attacker.

When SpellArg.EXCLUSIVE is set to true, this effect does not use up one of the attacker's attack counts.

When SpellArg.RANDOM_TARGET is set to true and a SpellArg.SECONDARY_TARGET (i.e. source) is specified, the resolved sources are removed from the list of target entities before the random choice is made.

For example, consider the text from Birb's You from the Future, "Summon a copy of a friendly minion. Then, it attacks the original":

   {
     "class": "SummonSpell",
     "spell": {
       "class": "FightSpell",
       "secondaryTarget": "OUTPUT"
     }
   }
 

Note that the EntityReference.OUTPUT refers to the newly copied minion. Since the copied minion is in the SpellArg.SECONDARY_TARGET specifier, the copied minion is the attacker. The target is implied to be the selected target of the spell, i.e., the original minion.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FightSpell()

Method Summary

Modifier and Type	Method	Description
void	cast(GameContext context, Player player, SpellDesc desc, Entity source, List<Entity> targets)	Casts a spell for the given arguments.
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

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

FightSpell

public FightSpell()

Method Details

cast

public void cast(GameContext context,
 Player player,
 SpellDesc desc,
 Entity source,
 List<Entity> targets)

Description copied from class: Spell

Casts a spell for the given arguments.

If there is at least one valid target in targets and SpellArg.RANDOM_TARGET is true, a single target from the list will be chosen at random.

If targets is null, this is a spell that does not ordinarily receive targets, so it will be cast once.

If targets.size() is 0, this spell takes targets but none were found, so the spell is not cast.

The EntityFilter specified in SpellArg.FILTER is applied to the list of targets to filter it. Therefore, this spell casting code is responsible for interpreting the SpellArg.FILTER and SpellArg.RANDOM_TARGET attributes of a SpellDesc.

Typically the targets list is generated by either using the player's single target choice from a combination of the spell or battlecry's TargetSelection applied through a SpellArg.FILTER (resulting in a list of length one), or the resolved SpellArg.TARGET predefined target reference (usually a group reference) resulting in a list of length zero or greater.

Overrides:

cast in class Spell

Parameters:

context - The game context

player - The casting player. This can be overridden by the SpellArg.TARGET_PLAYER arg in the desc.

desc - The spell description

source - The source entity of this spell cast

targets - A list of targets

See Also:

• for the logic which filters the targets argument.

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:

• for an example of a complex spell implementation.