com.elmakers.mine.bukkit.api.spell

Interface Spell

All Superinterfaces:

Comparable<SpellTemplate>, CostReducer, SpellTemplate

All Known Subinterfaces:

MageSpell

public interface Spell
extends SpellTemplate

Represents a Spell that may be cast by a Mage.

Each Spell is based on a SpellTemplate, which are defined by the spells configuration files.

Every spell uses a specific Class that must extend from com.elmakers.mine.bukkit.plugins.magic.spell.Spell.

To create a new custom spell from scratch, you must also implement the MageSpell interface.

Method Summary

Modifier and Type	Method and Description
boolean	brushIsErase()
boolean	canCast(org.bukkit.Location location)
boolean	cancel() Signal that this spell was cancelled.
boolean	cancelOnCastOther()
double	cancelOnDamage()
boolean	cancelOnDeactivate()
boolean	cancelOnDeath()
boolean	cancelOnNoPermission()
boolean	cancelOnNoWand()
boolean	cancelOnWorldChange()
boolean	cancelSelection() Cancel a selection in-progress for a two-click selection spell (like Architect magic)
boolean	canContinue(org.bukkit.Location location)
boolean	canTarget(org.bukkit.entity.Entity entity)
boolean	cast()
boolean	cast(org.bukkit.configuration.ConfigurationSection parameters)
boolean	cast(org.bukkit.configuration.ConfigurationSection parameters, org.bukkit.Location defaultLocation)
boolean	cast(String[] parameters)
boolean	cast(String[] parameters, org.bukkit.Location defaultLocation)
boolean	cast(Wand wand, org.bukkit.configuration.ConfigurationSection parameters)
void	castMessage(String message)
void	castMessageKey(String key, String message)
void	clearCooldown()
void	finish(CastContext context)
MaterialBrush	getBrush()
double	getChargesRemaining()
MageController	getController()
CastContext	getCurrentCast()
org.bukkit.util.Vector	getDirection()
org.bukkit.Color	getEffectColor()
MaterialAndData	getEffectMaterial()
String	getEffectParticle()
org.bukkit.entity.Entity	getEntity()
org.bukkit.Location	getEyeLocation()
org.bukkit.configuration.ConfigurationSection	getHandlerParameters(String handlerKey)
long	getLastCast()
org.bukkit.Location	getLocation()
String	getMessage(String messageKey)
long	getProgressLevel()
long	getRemainingCooldown()
CastingCost	getRequiredCost()
org.bukkit.entity.Entity	getTargetEntity()
org.bukkit.Location	getTargetLocation()
org.bukkit.configuration.ConfigurationSection	getVariables()
VariableScope	getVariableScope(String variableName)
org.bukkit.configuration.ConfigurationSection	getWorkingParameters()
boolean	hasBrushOverride()
boolean	hasHandlerParameters(String handlerKey)
boolean	isActive()
boolean	isCancellable()
boolean	isDisguiseRestricted()
boolean	isEnabled()
boolean	isPvpRestricted()
void	messageTargets(String messageKey)
void	playEffects(String effectName)
void	playEffects(String effectName, CastContext context)
void	playEffects(String effectName, CastContext context, float scale)
boolean	reactivate()
void	reduceRemainingCooldown(long ms)
default void	reloadParameters(CastContext context)
boolean	requiresBreakPermission()
boolean	requiresBuildPermission()
void	sendMessage(String message)
void	sendMessageKey(String key, String message)
void	setEnabled(boolean enabled)
void	setRemainingCooldown(long ms)
boolean	stop() Like a quiet version of cancel() - at some point cancel, stop and deactivate should all get cleaned up.
void	target()

Methods inherited from interface com.elmakers.mine.bukkit.api.spell.SpellTemplate

addLore, createMageSpell, createSpell, disableManaRegenerationWhenActive, getActiveCosts, getAlias, getCastCount, getCategory, getCategoryPermissionNode, getChargeRegeneration, getColor, getConfiguration, getCooldown, getCooldownDescription, getCost, getCosts, getCreator, getCreatorId, getDescription, getDisabledIcon, getDisabledIconURL, getDuration, getDurationDescription, getEarns, getEffects, getEffects, getExtendedDescription, getGlyph, getIcon, getIconURL, getKey, getLevelDescription, getMageCooldownDescription, getMaxCharges, getMaxProgressLevel, getName, getParameterOptions, getParameters, getPermissionNode, getPrerequisiteSpells, getRange, getRequiredUpgradeCasts, getRequiredUpgradePath, getRequiredUpgradeTags, getRequirements, getSpellKey, getSpellParameters, getSpellsToRemove, getTriggers, getUpgrade, getUpgradeDescription, getUsage, getWorth, hasAnyTag, hasCastPermission, hasIcon, hasTag, isHidden, isPassive, isQuickCast, isQuiet, isScheduledUndo, isToggleable, isUndoable, loadPrerequisites, loadTemplate, setCastCount, showBrush, showUndoable, usesBrush, usesBrushSelection

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.elmakers.mine.bukkit.api.spell.CostReducer

getConsumeReduction, getCostReduction, getCostScale, isConsumeFree, isCostFree

Method Detail

getController

MageController getController()

cast

boolean cast()

cast

boolean cast(@Nullable
             String[] parameters)

cast

boolean cast(@Nullable
             String[] parameters,
             @Nullable
             org.bukkit.Location defaultLocation)

cast

boolean cast(@Nullable
             org.bukkit.configuration.ConfigurationSection parameters,
             @Nullable
             org.bukkit.Location defaultLocation)

cast

boolean cast(@Nullable
             org.bukkit.configuration.ConfigurationSection parameters)

cast

boolean cast(@Nullable
             Wand wand,
             @Nullable
             org.bukkit.configuration.ConfigurationSection parameters)

getLocation

@Nullable
org.bukkit.Location getLocation()

getEntity

org.bukkit.entity.Entity getEntity()

getEyeLocation

org.bukkit.Location getEyeLocation()

target

void target()

getTargetLocation

@Nullable
org.bukkit.Location getTargetLocation()

getTargetEntity

@Nullable
org.bukkit.entity.Entity getTargetEntity()

getDirection

org.bukkit.util.Vector getDirection()

canTarget

boolean canTarget(org.bukkit.entity.Entity entity)

isActive

boolean isActive()

hasBrushOverride

boolean hasBrushOverride()

canContinue

boolean canContinue(org.bukkit.Location location)

canCast

boolean canCast(org.bukkit.Location location)

clearCooldown

void clearCooldown()

reduceRemainingCooldown

void reduceRemainingCooldown(long ms)

setRemainingCooldown

void setRemainingCooldown(long ms)

getRemainingCooldown

long getRemainingCooldown()

getRequiredCost

@Nullable
CastingCost getRequiredCost()

messageTargets

void messageTargets(String messageKey)

getCurrentCast

CastContext getCurrentCast()

playEffects

void playEffects(String effectName)

playEffects

void playEffects(String effectName,
                 CastContext context)

playEffects

void playEffects(String effectName,
                 CastContext context,
                 float scale)

requiresBuildPermission

boolean requiresBuildPermission()

requiresBreakPermission

boolean requiresBreakPermission()

isPvpRestricted

boolean isPvpRestricted()

isDisguiseRestricted

boolean isDisguiseRestricted()

sendMessage

void sendMessage(String message)

castMessage

void castMessage(String message)

sendMessageKey

void sendMessageKey(String key,
                    String message)

castMessageKey

void castMessageKey(String key,
                    String message)

getEffectMaterial

MaterialAndData getEffectMaterial()

getEffectParticle

@Nullable
String getEffectParticle()

getEffectColor

@Nullable
org.bukkit.Color getEffectColor()

getBrush

@Nullable
MaterialBrush getBrush()

brushIsErase

boolean brushIsErase()

isCancellable

boolean isCancellable()

getWorkingParameters

org.bukkit.configuration.ConfigurationSection getWorkingParameters()

finish

void finish(CastContext context)

cancelOnDamage

double cancelOnDamage()

cancelOnWorldChange

boolean cancelOnWorldChange()

cancelOnCastOther

boolean cancelOnCastOther()

cancelOnDeath

boolean cancelOnDeath()

cancelOnDeactivate

boolean cancelOnDeactivate()

getMessage

String getMessage(String messageKey)

hasHandlerParameters

boolean hasHandlerParameters(String handlerKey)

getHandlerParameters

@Nullable
org.bukkit.configuration.ConfigurationSection getHandlerParameters(String handlerKey)

getProgressLevel

long getProgressLevel()

cancelOnNoPermission

boolean cancelOnNoPermission()

cancelOnNoWand

boolean cancelOnNoWand()

reactivate

boolean reactivate()

getVariables

@Nonnull
org.bukkit.configuration.ConfigurationSection getVariables()

reloadParameters

default void reloadParameters(CastContext context)

cancel

boolean cancel()

Signal that this spell was cancelled. Will send cancel messages and play cancel FX.

This will not actually cancel any pending spell casts (batches) of this spell, for that you will need Mage.cancelPending

Returns:

true (for legacy reasons)

stop

boolean stop()

Like a quiet version of cancel() - at some point cancel, stop and deactivate should all get cleaned up.

cancelSelection

boolean cancelSelection()

Cancel a selection in-progress for a two-click selection spell (like Architect magic)

Will call cancel() if selection was cancelled.

Returns:

true if the spell was in the middle of selection and was cancelled.

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

getLastCast

long getLastCast()

getChargesRemaining

double getChargesRemaining()

getVariableScope

@Nullable
VariableScope getVariableScope(String variableName)