Wand (Magic API 10.2 API)

All Superinterfaces:

CasterProperties, CooldownReducer, CostReducer, MagicConfigurable, MagicProperties
```
public interface Wand
extends CostReducer, CooldownReducer, CasterProperties
```
Represents a Wand that a Mage may use to cast a Spell.
Every Wand has an inventory of Spell keys and Material brush keys that it may cast and use.
A Wand may also have a variety of properties, including effects, an XP ("Mana") pool for casting Spells with an XP-based CastingCost, and various boosts and protections.
Each Wand is backed by an ItemStack, and the Wand stores its data in the ItemStack. A Wand is otherwise not tracked or persistent, other than via the Mage.getActiveWand() method, or via a tracked LostWand record, if the ItemStack can be found.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activate(Mage mage)` Deprecated.
`boolean`	`add(Wand other, Mage mage)` Deprecated.
`boolean`	`addBrush(String key)`
`boolean`	`addEnchantments(Map<org.bukkit.enchantments.Enchantment,Integer> enchants)`
`boolean`	`addItem(org.bukkit.inventory.ItemStack item)`
`boolean`	`addSpell(String key)`
`boolean`	`alphabetizeInventory()`
`void`	`bind()`
`boolean`	`canProgress()` See if this wand can progress.
`boolean`	`canUse(org.bukkit.entity.Player player)`
`boolean`	`cast()`
`boolean`	`cast(Spell spell)`
`boolean`	`cast(String[] parameters)`
`boolean`	`checkUpgrade(boolean quiet)` See if this wand is ready for an upgrade.
`void`	`closeInventory()`
`boolean`	`configure(Map<String,Object> properties)` Deprecated.
`void`	`cycleHotbar()`
`void`	`damageDealt(double damage, org.bukkit.entity.Entity target)` Deprecated.
`void`	`deactivate()`
`void`	`describe(org.bukkit.command.CommandSender sender)` Print all properties to a CommandSender in a human-readable format.
`Wand`	`duplicate()`
`int`	`enchant(int levels)`
`int`	`enchant(int levels, Mage mage)`
`int`	`enchant(int levels, Mage mage, boolean addSpells)`
`boolean`	`fill(org.bukkit.entity.Player player)`
`boolean`	`fill(org.bukkit.entity.Player player, int maxLevel)`
`String`	`getActiveBrushKey()`
`Spell`	`getActiveSpell()`
`String`	`getActiveSpellKey()`
`SpellTemplate`	`getBaseSpell(String spellKey)`
`Collection<String>`	`getBrushes()`
`Map<String,Integer>`	`getBrushInventory()`
`MageContext`	`getContext()`
`MageController`	`getController()`
`float`	`getCooldownReduction()` Get the percent cooldown reduction, from 0.0 to 1.0
`float`	`getCostReduction()` Get the percent cost reduction, from 0.0 to 1.0
`int`	`getCurrentHotbar()`
`WandAction`	`getDropAction()`
`org.bukkit.Color`	`getEffectColor()`
`String`	`getEffectParticleName()`
`Map<org.bukkit.enchantments.Enchantment,Integer>`	`getEnchantments()`
`float`	`getHealthRegeneration()`
`int`	`getHeldSlot()`
`float`	`getHungerRegeneration()`
`MaterialAndData`	`getIcon()`
`String`	`getId()`
`MaterialAndData`	`getInactiveIcon()`
`org.bukkit.inventory.ItemStack`	`getItem()`
`WandAction`	`getLeftClickAction()`
`org.bukkit.Location`	`getLocation()`
`Mage`	`getMage()`
`MageClass`	`getMageClass()`
`String`	`getMageClassKey()`
`float`	`getMana()`
`int`	`getManaMax()`
`int`	`getManaRegeneration()`
`String`	`getName()`
`Map<String,String>`	`getOverrides()`
`WandUpgradePath`	`getPath()`
`float`	`getPower()`
`WandAction`	`getRightClickAction()`
`Spell`	`getSpell(String key)` Returns a Spell for a given spell key, if this caster has the spell.
`Spell`	`getSpell(String key, Mage mage)`
`Map<String,Integer>`	`getSpellInventory()`
`Collection<String>`	`getSpells()`
`SpellTemplate`	`getSpellTemplate(String key)` Returns the SpellTemplate representing the requested spell key at the correct level.
`WandAction`	`getSwapAction()`
`WandTemplate`	`getTemplate()`
`String`	`getTemplateKey()`
`long`	`getWorth()`
`boolean`	`hasBrush(String key)`
`boolean`	`hasInventory()`
`boolean`	`hasSlot(String slot)`
`boolean`	`hasSpell(SpellKey spellKey)`
`boolean`	`hasSpell(String key)`
`boolean`	`hasTag(String tag)`
`boolean`	`hasUpgrade()` Check to see if this wand has an upgrade on its current path
`boolean`	`isBlocked(double angle)` Deprecated.
`boolean`	`isBound()`
`boolean`	`isConsumeFree()`
`boolean`	`isCooldownFree()` Check if cooldowns should be bypassed completely.
`boolean`	`isCostFree()`
`boolean`	`isEnchantable()`
`boolean`	`isIndestructible()`
`boolean`	`isInOffhand()`
`boolean`	`isInventoryOpen()`
`boolean`	`isLocked()`
`boolean`	`isLost(LostWand wand)`
`boolean`	`isModifiable()`
`boolean`	`isQuickCast()`
`boolean`	`isQuickCastDisabled()`
`boolean`	`isReflected(double angle)` Deprecated.
`boolean`	`isSoul()` Deprecated.
`boolean`	`isSuperPowered()`
`boolean`	`isSuperProtected()`
`boolean`	`isUndroppable()`
`LostWand`	`makeLost(org.bukkit.Location location)`
`void`	`makeModifiable()`
`void`	`makeUpgrade()`
`boolean`	`organizeInventory()`
`boolean`	`organizeInventory(Mage mage)`
`String`	`parameterize(String command)`
`boolean`	`performAction(WandAction action)`
`boolean`	`playEffects(String key)`
`boolean`	`removeBrush(String key)`
`void`	`removeMana(float mana)`
`void`	`removeOverride(String key)`
`boolean`	`removeProperty(String key)` Remove a property from this store.
`boolean`	`removeSpell(String key)`
`void`	`save(org.bukkit.configuration.ConfigurationSection section, boolean filtered)` Save this Wand to a Configuration Section.
`void`	`saveState()` Save current Wand state to the ItemStack's NBT data immediately.
`void`	`setActiveBrush(String key)`
`void`	`setActiveSpell(String key)`
`void`	`setCurrentHotbar(int hotbar)`
`void`	`setDescription(String description)`
`void`	`setEnchantments(Map<org.bukkit.enchantments.Enchantment,Integer> enchants)`
`void`	`setHeldSlot(int slot)`
`void`	`setIcon(MaterialAndData icon)`
`void`	`setInactiveIcon(MaterialAndData icon)`
`void`	`setMana(float mana)`
`void`	`setManaMax(int manaMax)` Deprecated.
`void`	`setName(String name)`
`void`	`setOverride(String key, String value)`
`void`	`setOverrides(Map<String,String> overrides)`
`boolean`	`showCastMessages()`
`void`	`showInstructions()`
`boolean`	`showMessages()`
`void`	`unbind()`
`void`	`unenchant()`
`void`	`unlock()` Deprecated.
`void`	`updateBrushInventory(Map<String,Integer> updateBrushes)`
`void`	`updateMana()`
`void`	`updateSpellInventory(Map<String,Integer> updateSpells)`
`boolean`	`upgrade(boolean quiet)` Trigger an upgrade to the next path.
`boolean`	`upgrade(Map<String,Object> properties)` Deprecated.

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

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.CasterProperties
add, checkAndUpgrade, forceAddSpell, getAttribute, getEffectiveManaMax, getEffectiveManaRegeneration, getLevel, getMaxSpells, getSpellLevel, randomize, sendMessageKey, setAttribute, setManaMax, setManaRegeneration, setManaRegeneration, setPath, setSpellLevel, setSpelLLevel, upgradesAllowed

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicConfigurable
configure, configure, getStorage, upgrade, upgrade

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicProperties
describe, getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getProperty, getProperty, getProperty, getSectionList, getString, getString, getStringList, hasProperty, isEmpty

- Method Detail
  - getName
```
String getName()
```
  - getId
```
String getId()
```
  - getWorth
```
long getWorth()
```
  - closeInventory
```
void closeInventory()
```
  - deactivate
```
void deactivate()
```
  - organizeInventory
```
boolean organizeInventory(Mage mage)
```
  - organizeInventory
```
boolean organizeInventory()
```
  - alphabetizeInventory
```
boolean alphabetizeInventory()
```
  - getBrushInventory
```
Map<String,Integer> getBrushInventory()
```
  - updateBrushInventory
```
void updateBrushInventory(Map<String,Integer> updateBrushes)
```
  - getSpellInventory
```
Map<String,Integer> getSpellInventory()
```
  - updateSpellInventory
```
void updateSpellInventory(Map<String,Integer> updateSpells)
```
  - getItem
```
@Nullable
org.bukkit.inventory.ItemStack getItem()
```
  - getIcon
```
MaterialAndData getIcon()
```
  - getInactiveIcon
```
MaterialAndData getInactiveIcon()
```
  - setIcon
```
void setIcon(MaterialAndData icon)
```
  - setInactiveIcon
```
void setInactiveIcon(MaterialAndData icon)
```
  - makeUpgrade
```
void makeUpgrade()
```
  - getSpells
```
Collection<String> getSpells()
```
    Specified by:
    
    getSpells in interface CasterProperties
  - getBrushes
```
Collection<String> getBrushes()
```
    Specified by:
    
    getBrushes in interface CasterProperties
  - describe
```
void describe(org.bukkit.command.CommandSender sender)
```
    Description copied from interface: MagicProperties
    
    Print all properties to a CommandSender in a human-readable format.
    
    Specified by:
    
    describe in interface MagicProperties
    
    Parameters:
    
    sender - Where to print properties.
  - unenchant
```
void unenchant()
```
  - unlock
```
@Deprecated
void unlock()
```
    Deprecated.
  - makeModifiable
```
void makeModifiable()
```
  - duplicate
```
Wand duplicate()
```
  - getSpell
```
Spell getSpell(String key)
```
    Description copied from interface: CasterProperties
    
    Returns a Spell for a given spell key, if this caster has the spell.
    Will return the correct spell level for the given spell, regardless of the level requested.
    
    Specified by:
    
    getSpell in interface CasterProperties
    
    Parameters:
    
    key - The spell key to request
    
    Returns:
    
    the Spell, or null if not present here.
  - getSpell
```
@Nullable
Spell getSpell(String key,
                         Mage mage)
```
  - getSpellTemplate
```
@Nullable
SpellTemplate getSpellTemplate(String key)
```
    Description copied from interface: CasterProperties
    
    Returns the SpellTemplate representing the requested spell key at the correct level.
    
    Specified by:
    
    getSpellTemplate in interface CasterProperties
    
    Parameters:
    
    key - The key of the spell being requested
    
    Returns:
    
    The SpellTemplate requested, or null if this class doesn't have the requested spell
  - hasSpell
```
boolean hasSpell(String key)
```
    Specified by:
    
    hasSpell in interface CasterProperties
  - hasSpell
```
boolean hasSpell(SpellKey spellKey)
```
  - hasBrush
```
boolean hasBrush(String key)
```
    Specified by:
    
    hasBrush in interface CasterProperties
  - isModifiable
```
boolean isModifiable()
```
  - isLocked
```
boolean isLocked()
```
  - canUse
```
boolean canUse(org.bukkit.entity.Player player)
```
  - fill
```
boolean fill(org.bukkit.entity.Player player)
```
  - fill
```
boolean fill(org.bukkit.entity.Player player,
             int maxLevel)
```
  - add
```
@Deprecated
boolean add(Wand other,
                        Mage mage)
```
    Deprecated.
  - addItem
```
boolean addItem(org.bukkit.inventory.ItemStack item)
```
    Specified by:
    
    addItem in interface CasterProperties
  - removeProperty
```
boolean removeProperty(String key)
```
    Description copied from interface: MagicConfigurable
    
    Remove a property from this store.
    If this property is inherited, it cannot be removed. If this property exists but an inherited value also exists, the property will now have the inherited value.
    
    Specified by:
    
    removeProperty in interface MagicConfigurable
    
    Parameters:
    
    key - The key to remove
    
    Returns:
    
    true if the property existed and was removed.
  - addBrush
```
boolean addBrush(String key)
```
    Specified by:
    
    addBrush in interface CasterProperties
  - addSpell
```
boolean addSpell(String key)
```
    Specified by:
    
    addSpell in interface CasterProperties
  - removeBrush
```
boolean removeBrush(String key)
```
  - removeSpell
```
boolean removeSpell(String key)
```
  - getActiveBrushKey
```
String getActiveBrushKey()
```
  - getActiveSpellKey
```
String getActiveSpellKey()
```
  - getActiveSpell
```
@Nullable
Spell getActiveSpell()
```
  - setActiveBrush
```
void setActiveBrush(String key)
```
  - setActiveSpell
```
void setActiveSpell(String key)
```
  - setName
```
void setName(String name)
```
  - setDescription
```
void setDescription(String description)
```
  - makeLost
```
LostWand makeLost(org.bukkit.Location location)
```
  - isLost
```
boolean isLost(LostWand wand)
```
  - enchant
```
int enchant(int levels)
```
  - enchant
```
int enchant(int levels,
            Mage mage)
```
  - enchant
```
int enchant(int levels,
            Mage mage,
            boolean addSpells)
```
  - getOverrides
```
Map<String,String> getOverrides()
```
  - setOverrides
```
void setOverrides(Map<String,String> overrides)
```
  - removeOverride
```
void removeOverride(String key)
```
  - setOverride
```
void setOverride(String key,
                 String value)
```
  - getBaseSpell
```
SpellTemplate getBaseSpell(String spellKey)
```
  - isSuperProtected
```
boolean isSuperProtected()
```
  - isSuperPowered
```
boolean isSuperPowered()
```
  - isCostFree
```
boolean isCostFree()
```
    Specified by:
    
    isCostFree in interface CasterProperties
    
    Specified by:
    
    isCostFree in interface CostReducer
  - isConsumeFree
```
boolean isConsumeFree()
```
    Specified by:
    
    isConsumeFree in interface CasterProperties
    
    Specified by:
    
    isConsumeFree in interface CostReducer
  - isCooldownFree
```
boolean isCooldownFree()
```
    Description copied from interface: CooldownReducer
    
    Check if cooldowns should be bypassed completely.
    
    Specified by:
    
    isCooldownFree in interface CasterProperties
    
    Specified by:
    
    isCooldownFree in interface CooldownReducer
    
    Returns:
    
    True if cooldowns are disabled
  - getPower
```
float getPower()
```
  - getHealthRegeneration
```
float getHealthRegeneration()
```
  - getHungerRegeneration
```
float getHungerRegeneration()
```
  - getCooldownReduction
```
float getCooldownReduction()
```
    Description copied from interface: CooldownReducer
    
    Get the percent cooldown reduction, from 0.0 to 1.0
    
    Specified by:
    
    getCooldownReduction in interface CooldownReducer
    
    Returns:
    
    The percent cooldown reduction.
  - getCostReduction
```
float getCostReduction()
```
    Description copied from interface: CostReducer
    
    Get the percent cost reduction, from 0.0 to 1.0
    
    Specified by:
    
    getCostReduction in interface CostReducer
    
    Returns:
    
    The percent cost reduction.
  - removeMana
```
void removeMana(float mana)
```
    Specified by:
    
    removeMana in interface CasterProperties
  - getMana
```
float getMana()
```
    Specified by:
    
    getMana in interface CasterProperties
  - getManaMax
```
int getManaMax()
```
    Specified by:
    
    getManaMax in interface CasterProperties
  - setMana
```
void setMana(float mana)
```
    Specified by:
    
    setMana in interface CasterProperties
  - setManaMax
```
@Deprecated
void setManaMax(int manaMax)
```
    Deprecated.
    
    Specified by:
    
    setManaMax in interface CasterProperties
  - getManaRegeneration
```
int getManaRegeneration()
```
    Specified by:
    
    getManaRegeneration in interface CasterProperties
  - updateMana
```
void updateMana()
```
  - getPath
```
WandUpgradePath getPath()
```
    Specified by:
    
    getPath in interface CasterProperties
  - getController
```
MageController getController()
```
    Specified by:
    
    getController in interface CasterProperties
  - showCastMessages
```
boolean showCastMessages()
```
  - showMessages
```
boolean showMessages()
```
  - getTemplateKey
```
@Nullable
String getTemplateKey()
```
  - getTemplate
```
@Nullable
WandTemplate getTemplate()
```
  - isIndestructible
```
boolean isIndestructible()
```
  - playEffects
```
boolean playEffects(String key)
```
  - cast
```
boolean cast()
```
  - cast
```
boolean cast(String[] parameters)
```
  - cast
```
boolean cast(Spell spell)
```
  - isBound
```
boolean isBound()
```
  - isUndroppable
```
boolean isUndroppable()
```
  - isQuickCastDisabled
```
boolean isQuickCastDisabled()
```
  - isInventoryOpen
```
boolean isInventoryOpen()
```
  - isQuickCast
```
boolean isQuickCast()
```
  - cycleHotbar
```
void cycleHotbar()
```
  - setCurrentHotbar
```
void setCurrentHotbar(int hotbar)
```
  - getCurrentHotbar
```
int getCurrentHotbar()
```
  - hasTag
```
boolean hasTag(String tag)
```
  - hasSlot
```
boolean hasSlot(String slot)
```
  - bind
```
void bind()
```
  - unbind
```
void unbind()
```
  - save
```
void save(org.bukkit.configuration.ConfigurationSection section,
          boolean filtered)
```
    Save this Wand to a Configuration Section.
    
    Parameters:
    
    section - The section to save to.
    
    filtered - If true, removes item-specific data such as Wand id and bound owner.
  - saveState
```
void saveState()
```
    Save current Wand state to the ItemStack's NBT data immediately.
    Wands are saved periodically so this is generally not needed unless you need to force an update right away.
  - checkUpgrade
```
boolean checkUpgrade(boolean quiet)
```
    See if this wand is ready for an upgrade.
    
    Parameters:
    
    quiet - if false, will send messages to a player informing them why they are blocked
    
    Returns:
    
    false if the wand is blocked from upgrading for some reason
  - hasUpgrade
```
boolean hasUpgrade()
```
    Check to see if this wand has an upgrade on its current path
    
    Returns:
    
    true if this wand has a path with an upgrade
  - canProgress
```
boolean canProgress()
```
    See if this wand can progress. This means the wand can still acquire more spells on its current path, or can otherwise be upgraded in some way via enchanting or the spell menu.
    
    Specified by:
    
    canProgress in interface CasterProperties
    
    Returns:
    
    true if the wand can progress
  - upgrade
```
boolean upgrade(boolean quiet)
```
    Trigger an upgrade to the next path.
    
    Parameters:
    
    quiet - if false, will send messages to the player about their upgrade
    
    Returns:
    
    true if the upgrade was successful.
  - upgrade
```
@Deprecated
boolean upgrade(Map<String,Object> properties)
```
    Deprecated.
    
    This method is deprecated, it just converts the Map to a ConfigurationSection.
    Use MagicConfigurable.upgrade(ConfigurationSection) instead.
  - activate
```
@Deprecated
void activate(Mage mage)
```
    Deprecated.
    
    This method is deprecated, use Mage.checkWand() instead. Wands should only ever be active while held.
  - getEffectColor
```
@Nullable
org.bukkit.Color getEffectColor()
```
    Specified by:
    
    getEffectColor in interface CasterProperties
  - getEffectParticleName
```
String getEffectParticleName()
```
    Specified by:
    
    getEffectParticleName in interface CasterProperties
  - getLocation
```
@Nullable
org.bukkit.Location getLocation()
```
  - getMage
```
Mage getMage()
```
    Specified by:
    
    getMage in interface CasterProperties
  - getMageClass
```
@Nullable
MageClass getMageClass()
```
  - getMageClassKey
```
@Nullable
String getMageClassKey()
```
  - hasInventory
```
boolean hasInventory()
```
  - getHeldSlot
```
int getHeldSlot()
```
  - setHeldSlot
```
void setHeldSlot(int slot)
```
  - isInOffhand
```
boolean isInOffhand()
```
  - configure
```
@Deprecated
boolean configure(Map<String,Object> properties)
```
    Deprecated.
    
    This method is deprecated, it just converts the Map to a ConfigurationSection.
    Use MagicConfigurable.configure(ConfigurationSection) instead.
  - isSoul
```
@Deprecated
boolean isSoul()
```
    Deprecated.
  - getDropAction
```
WandAction getDropAction()
```
  - getRightClickAction
```
WandAction getRightClickAction()
```
  - getLeftClickAction
```
WandAction getLeftClickAction()
```
  - getSwapAction
```
WandAction getSwapAction()
```
  - performAction
```
boolean performAction(WandAction action)
```
  - getContext
```
@Nonnull
MageContext getContext()
```
  - isEnchantable
```
boolean isEnchantable()
```
  - setEnchantments
```
void setEnchantments(Map<org.bukkit.enchantments.Enchantment,Integer> enchants)
```
  - addEnchantments
```
boolean addEnchantments(Map<org.bukkit.enchantments.Enchantment,Integer> enchants)
```
  - getEnchantments
```
@Nonnull
Map<org.bukkit.enchantments.Enchantment,Integer> getEnchantments()
```
  - showInstructions
```
void showInstructions()
```
  - parameterize
```
String parameterize(String command)
```
  - damageDealt
```
@Deprecated
void damageDealt(double damage,
                             org.bukkit.entity.Entity target)
```
    Deprecated.
  - isReflected
```
@Deprecated
boolean isReflected(double angle)
```
    Deprecated.
  - isBlocked
```
@Deprecated
boolean isBlocked(double angle)
```
    Deprecated.

Interface Wand

Method Summary

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

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.CasterProperties

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicConfigurable

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicProperties

Method Detail

getName

getId

getWorth

closeInventory

deactivate

organizeInventory

organizeInventory

alphabetizeInventory

getBrushInventory

updateBrushInventory

getSpellInventory

updateSpellInventory

getItem

getIcon

getInactiveIcon

setIcon

setInactiveIcon

makeUpgrade

getSpells

getBrushes

describe

unenchant

unlock

makeModifiable

duplicate

getSpell

getSpell

getSpellTemplate

hasSpell

hasSpell

hasBrush

isModifiable

isLocked

canUse

fill

fill

add

addItem

removeProperty

addBrush

addSpell

removeBrush

removeSpell

getActiveBrushKey

getActiveSpellKey

getActiveSpell

setActiveBrush

setActiveSpell

setName

setDescription

makeLost

isLost

enchant

enchant

enchant

getOverrides

setOverrides

removeOverride

setOverride

getBaseSpell

isSuperProtected

isSuperPowered

isCostFree

isConsumeFree

isCooldownFree

getPower

getHealthRegeneration

getHungerRegeneration

getCooldownReduction

getCostReduction

removeMana

getMana

getManaMax