Package net.demilich.metastone.game.spells

Class RelativeToTargetEffectSpell

java.lang.Object

net.demilich.metastone.game.spells.Spell

net.demilich.metastone.game.spells.RelativeToTargetEffectSpell

All Implemented Interfaces:

Serializable, HasDesc<SpellDesc>

Direct Known Subclasses:

AdjacentEffectSpell, OppositeEffectSpell

public abstract class RelativeToTargetEffectSpell
extends Spell

This abstract class provides a way to cast spell effects on targets.

• SpellArg.SPELL1 is cast on target.
• SpellArg.SPELL2 is cast on the result of getActors(GameContext, SpellDesc, Entity, Entity) of that target.
• SpellArg.SPELL is cast on both, only if neither of the above were specified.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RelativeToTargetEffectSpell()

Method Summary

Modifier and Type	Method	Description
protected abstract List<Actor>	getActors(GameContext context, SpellDesc desc, Entity source, Entity target)
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

RelativeToTargetEffectSpell

public RelativeToTargetEffectSpell()

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:

• for an example of a complex spell implementation.

getActors

protected abstract List<Actor> getActors(GameContext context,
 SpellDesc desc,
 Entity source,
 Entity target)