SpellTemplate (Magic API 10.2 API)

All Superinterfaces:

Comparable<SpellTemplate>, CostReducer

All Known Subinterfaces:

MageSpell, Spell
```
public interface SpellTemplate
extends Comparable<SpellTemplate>, CostReducer
```
A Spell template, as defined in the spells configuration files.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLore(Messages messages, Mage mage, Wand wand, List<String> lore)`
`MageSpell`	`createMageSpell(Mage mage)`
`Spell`	`createSpell()` Deprecated.
`boolean`	`disableManaRegenerationWhenActive()`
`Collection<CastingCost>`	`getActiveCosts()`
`String`	`getAlias()`
`long`	`getCastCount()`
`SpellCategory`	`getCategory()`
`String`	`getCategoryPermissionNode()`
`double`	`getChargeRegeneration()`
`org.bukkit.Color`	`getColor()`
`org.bukkit.configuration.ConfigurationSection`	`getConfiguration()`
`long`	`getCooldown()`
`String`	`getCooldownDescription()`
`Cost`	`getCost()` The cost to purchase this spell.
`Collection<CastingCost>`	`getCosts()` The costs to cast this spell.
`String`	`getCreator()`
`String`	`getCreatorId()` This can hold the UUID of the owner of this spell, when using an editor that supports saving owned spells.
`String`	`getDescription()`
`MaterialAndData`	`getDisabledIcon()`
`String`	`getDisabledIconURL()`
`long`	`getDuration()`
`String`	`getDurationDescription(Messages messages)`
`double`	`getEarns()`
`Collection<EffectPlayer>`	`getEffects(SpellResult result)`
`Collection<EffectPlayer>`	`getEffects(String effectsKey)`
`String`	`getExtendedDescription()`
`String`	`getGlyph()`
`MaterialAndData`	`getIcon()`
`String`	`getIconURL()`
`String`	`getKey()`
`String`	`getLevelDescription()`
`String`	`getMageCooldownDescription()`
`int`	`getMaxCharges()`
`long`	`getMaxProgressLevel()` Returns the maximum progress level for this spell.
`String`	`getName()`
`void`	`getParameterOptions(Collection<String> examples, String parameterKey)` Add examples of possible values for a given parameter to this spell.
`void`	`getParameters(Collection<String> parameters)` Add this spell's possible parameter keys to a collection.
`String`	`getPermissionNode()`
`Collection<PrerequisiteSpell>`	`getPrerequisiteSpells()`
`double`	`getRange()`
`long`	`getRequiredUpgradeCasts()`
`String`	`getRequiredUpgradePath()`
`Set<String>`	`getRequiredUpgradeTags()`
`Collection<Requirement>`	`getRequirements()`
`SpellKey`	`getSpellKey()`
`org.bukkit.configuration.ConfigurationSection`	`getSpellParameters()` Retrieve the parameters as configured in this spell's parameters section.
`Collection<SpellKey>`	`getSpellsToRemove()` Returns a collection of spell keys of spells that should be removed when this spell is added to a wand.
`Collection<Trigger>`	`getTriggers()`
`SpellTemplate`	`getUpgrade()`
`String`	`getUpgradeDescription()`
`String`	`getUsage()`
`double`	`getWorth()` How much this spell is worth.
`boolean`	`hasAnyTag(Collection<String> tags)`
`boolean`	`hasCastPermission(org.bukkit.command.CommandSender sender)`
`boolean`	`hasIcon()`
`boolean`	`hasTag(String tag)`
`boolean`	`isHidden()`
`boolean`	`isPassive()`
`boolean`	`isQuickCast()`
`boolean`	`isQuiet()`
`boolean`	`isScheduledUndo()`
`boolean`	`isToggleable()`
`boolean`	`isUndoable()`
`void`	`loadPrerequisites(org.bukkit.configuration.ConfigurationSection node)`
`void`	`loadTemplate(String key, org.bukkit.configuration.ConfigurationSection node)`
`void`	`setCastCount(long count)`
`boolean`	`showBrush()`
`boolean`	`showUndoable()`
`boolean`	`usesBrush()`
`boolean`	`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

getName
```
String getName()
```

getAlias
```
String getAlias()
```

getDescription
```
String getDescription()
```

getExtendedDescription
```
String getExtendedDescription()
```

getLevelDescription
```
String getLevelDescription()
```

getCooldownDescription

@Nullable
String getCooldownDescription()

getMageCooldownDescription

@Nullable
String getMageCooldownDescription()

getMaxCharges
```
int getMaxCharges()
```

getChargeRegeneration
```
double getChargeRegeneration()
```

getKey
```
String getKey()
```

getSpellKey
```
SpellKey getSpellKey()
```

getColor
```
@Nullable
org.bukkit.Color getColor()
```

getCost
```
@Nullable
Cost getCost()
```
The cost to purchase this spell.

Returns:

The cost of this spell, or null if this spell is free.

getWorth
```
double getWorth()
```
How much this spell is worth. This will be the same as the amount provided by getCost, or zero if this spell is free.

Returns:

How much this spell is worth, in whatever currency the spellshop is configured to work in.

getEarns
```
double getEarns()
```

getRange
```
double getRange()
```

getCategory
```
SpellCategory getCategory()
```

getCastCount
```
long getCastCount()
```

setCastCount
```
void setCastCount(long count)
```

getUsage
```
String getUsage()
```

getIcon
```
MaterialAndData getIcon()
```

getDisabledIcon
```
MaterialAndData getDisabledIcon()
```

getIconURL
```
String getIconURL()
```

getDisabledIconURL
```
String getDisabledIconURL()
```

getGlyph
```
@Nullable
String getGlyph()
```

hasIcon
```
boolean hasIcon()
```

hasCastPermission

boolean hasCastPermission(org.bukkit.command.CommandSender sender)

getCosts
```
@Nullable
Collection<CastingCost> getCosts()
```
The costs to cast this spell.

Returns:

A list of casting costs, or null if this spell is free to cast.

getActiveCosts

@Nullable
Collection<CastingCost> getActiveCosts()

getEffects

Collection<EffectPlayer> getEffects(SpellResult result)

getEffects

Collection<EffectPlayer> getEffects(String effectsKey)

getDuration
```
long getDuration()
```

getDurationDescription

@Nullable
String getDurationDescription(Messages messages)

getCooldown
```
long getCooldown()
```

createSpell

@Nullable
 @Deprecated
Spell createSpell()

Deprecated.

createMageSpell

@Nullable
MageSpell createMageSpell(Mage mage)

loadTemplate

void loadTemplate(String key,
                  org.bukkit.configuration.ConfigurationSection node)

loadPrerequisites

void loadPrerequisites(org.bukkit.configuration.ConfigurationSection node)

getPermissionNode
```
String getPermissionNode()
```

getCategoryPermissionNode

@Nullable
String getCategoryPermissionNode()

isHidden
```
boolean isHidden()
```

usesBrush
```
boolean usesBrush()
```

usesBrushSelection
```
boolean usesBrushSelection()
```

showBrush
```
boolean showBrush()
```

isUndoable
```
boolean isUndoable()
```

showUndoable
```
boolean showUndoable()
```

isScheduledUndo
```
boolean isScheduledUndo()
```

isQuickCast
```
boolean isQuickCast()
```

disableManaRegenerationWhenActive

boolean disableManaRegenerationWhenActive()

getRequiredUpgradePath
```
String getRequiredUpgradePath()
```

getRequiredUpgradeTags
```
Set<String> getRequiredUpgradeTags()
```

getRequiredUpgradeCasts
```
long getRequiredUpgradeCasts()
```

getPrerequisiteSpells

Collection<PrerequisiteSpell> getPrerequisiteSpells()

getSpellsToRemove
```
Collection<SpellKey> getSpellsToRemove()
```
Returns a collection of spell keys of spells that should be removed when this spell is added to a wand.

getUpgradeDescription
```
String getUpgradeDescription()
```

getConfiguration

org.bukkit.configuration.ConfigurationSection getConfiguration()

addLore

void addLore(Messages messages,
             Mage mage,
             Wand wand,
             List<String> lore)

hasTag
```
boolean hasTag(String tag)
```

hasAnyTag

boolean hasAnyTag(Collection<String> tags)

getUpgrade
```
@Nullable
SpellTemplate getUpgrade()
```

getMaxProgressLevel
```
long getMaxProgressLevel()
```
Returns the maximum progress level for this spell.
This may return 0 even though a spell's current progress level is always 1 or greater. A result of 0 indicates that progress levels are not used for this spell.

getSpellParameters
```
org.bukkit.configuration.ConfigurationSection getSpellParameters()
```
Retrieve the parameters as configured in this spell's parameters section.

Returns:

The configured spell parameters

getParameters
```
void getParameters(Collection<String> parameters)
```
Add this spell's possible parameter keys to a collection. Used for tab-completion.

Parameters:

parameters - A non-null collection of spell parameters to add to.

getParameterOptions
```
void getParameterOptions(Collection<String> examples,
                         String parameterKey)
```
Add examples of possible values for a given parameter to this spell. Used for tab-completion.

Parameters:

examples - A collection of strings to add possible parameter values to

parameterKey - The parameter for which to retrieve example options.

getRequirements

Collection<Requirement> getRequirements()

getCreatorId
```
@Nullable
String getCreatorId()
```
This can hold the UUID of the owner of this spell, when using an editor that supports saving owned spells.

Returns:

The id of the creator of this spell

getCreator
```
@Nullable
String getCreator()
```

isToggleable
```
boolean isToggleable()
```

isPassive
```
boolean isPassive()
```

isQuiet
```
boolean isQuiet()
```

getTriggers

@Nullable
Collection<Trigger> getTriggers()

Interface SpellTemplate

Method Summary

Methods inherited from interface java.lang.Comparable

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

Method Detail

getName

getAlias

getDescription

getExtendedDescription

getLevelDescription

getCooldownDescription

getMageCooldownDescription

getMaxCharges

getChargeRegeneration

getKey

getSpellKey

getColor

getCost

getWorth

getEarns

getRange

getCategory

getCastCount

setCastCount

getUsage

getIcon

getDisabledIcon

getIconURL

getDisabledIconURL

getGlyph

hasIcon

hasCastPermission

getCosts

getActiveCosts

getEffects

getEffects

getDuration

getDurationDescription

getCooldown

createSpell

createMageSpell

loadTemplate

loadPrerequisites

getPermissionNode

getCategoryPermissionNode

isHidden

usesBrush

usesBrushSelection

showBrush

isUndoable

showUndoable

isScheduledUndo

isQuickCast

disableManaRegenerationWhenActive

getRequiredUpgradePath

getRequiredUpgradeTags

getRequiredUpgradeCasts

getPrerequisiteSpells

getSpellsToRemove

getUpgradeDescription

getConfiguration

addLore

hasTag

hasAnyTag

getUpgrade

getMaxProgressLevel

getSpellParameters

getParameters

getParameterOptions

getRequirements

getCreatorId

getCreator

isToggleable

isPassive

isQuiet

getTriggers