Package net.demilich.metastone.game.spells

Class NullSpell

java.lang.Object

net.demilich.metastone.game.spells.Spell

net.demilich.metastone.game.spells.NullSpell

All Implemented Interfaces:

Serializable, HasDesc<SpellDesc>

public class NullSpell
extends Spell

A spell that has no effects.

This is useful for situations where a spell must be specified, like in a CardDesc.spell property in its JSON, but when no effects are intended.

For example, place the following as the spell property in the card JSON for a spell card that should do nothing:

     {
         "class": "NullSpell"
     }
 

This implements cards like Dimensius's Stop card ("Full Belly"), which should do nothing but still needs to be cast.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NullSpell()

Method Summary

Modifier and Type	Method	Description
static SpellDesc	create()	Creates a spell that does nothing.
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

NullSpell

public NullSpell()

Method Details

create

public static SpellDesc create()

Creates a spell that does nothing.

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.

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.