Package com.binaris.wizardry.api.content.spell

Class NoneSpell

java.lang.Object

com.binaris.wizardry.api.content.spell.Spell

com.binaris.wizardry.api.content.spell.NoneSpell

public final class NoneSpell
extends Spell

This is an empty spell used for whenever a non-null empty spell is needed; it's great for using as a template when making your own spell.

Field Summary

Fields inherited from class com.binaris.wizardry.api.content.spell.Spell

pitch, pitchVariation, volume

Constructor Summary

Constructors

Constructor	Description
NoneSpell()

Method Summary

Modifier and Type	Method	Description
boolean	cast(PlayerCastContext ctx)
protected @NotNull SpellProperties	properties()
boolean	requiresPacket()	Whether this spell requires a packet to be sent when it is cast.

Methods inherited from class com.binaris.wizardry.api.content.spell.Spell

assignProperties, canCastByEntity, canCastByLocation, cast, cast, endCast, getAction, getCharge, getCooldown, getCost, getDesc, getDescriptionFormatted, getDescriptionId, getElement, getIcon, getLocation, getLoopSounds, getOrCreateDescriptionId, getOrCreateLocation, getPitch, getPitchVariation, getProperties, getTier, getType, getVolume, hasEnded, is, is, is, isEmpty, isEnabled, isInstantCast, onCharge, playSound, playSound, playSound, playSoundLoop, playSoundLoop, property, setProperties, soundValues, toString

Methods inherited from class java.lang.Object

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

Constructor Details

NoneSpell

public NoneSpell()

Method Details

cast

public boolean cast(PlayerCastContext ctx)

Specified by:

cast in class Spell

requiresPacket

public boolean requiresPacket()

Description copied from class: Spell

Whether this spell requires a packet to be sent when it is cast. Returns true by default, but can be overridden to return false if the spell's cast() method does not use any code that must be executed client-side (i.e. particle spawning). This is not checked for continuous spells, because they never need to send packets.

If in doubt, leave this method as is; it is purely an optimisation.

Overrides:

requiresPacket in class Spell

Returns:

true if the spell code should be run on the server and all clients in the dimension, false if the spell code should only be run on the server and the client of the player casting it.

properties

@NotNull
protected @NotNull SpellProperties properties()

Specified by:

properties in class Spell