Package net.demilich.metastone.game.spells

Class RemoveActorPeacefullySpell

java.lang.Object

net.demilich.metastone.game.spells.Spell

net.demilich.metastone.game.spells.RemoveActorPeacefullySpell

All Implemented Interfaces:

Serializable, HasDesc<SpellDesc>

public final class RemoveActorPeacefullySpell
extends Spell

Removes a target actor peacefully (without triggering its deathrattles) from its current zone.

If a SpellArg.SPELL is specified, it is cast with the target as EntityReference.OUTPUT before it is removed from the zone it is currently in. Does nothing if the target is destroyed or if the target is not in play.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RemoveActorPeacefullySpell()

Method Summary

Modifier and Type	Method	Description
static SpellDesc	create(EntityReference target, EntityFilter filter, boolean randomTarget)
static SpellDesc	create(EntityReference target, EntityFilter filter, boolean randomTarget, SpellDesc beforeRemoved)
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

RemoveActorPeacefullySpell

public RemoveActorPeacefullySpell()

Method Details

create

public static SpellDesc create(EntityReference target,
 EntityFilter filter,
 boolean randomTarget)

create

public static SpellDesc create(EntityReference target,
 EntityFilter filter,
 boolean randomTarget,
 SpellDesc beforeRemoved)

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.