Mage (Magic API 10.2 API)

All Superinterfaces:

CooldownReducer, CostReducer
```
public interface Mage
extends CostReducer, CooldownReducer
```
A Mage represents any entity that may cast spells. This can include:
- A Player. Mages for Players will be persisted and destroyed if a Player logs out. By default a Mage will be kept around if a Player has anything in their undo queue, so that an admin may Rewind their constructions after logout.
- A CommandBlockSender. A Command block will have a Mage if it uses /cast. Each Command block will have a unique Mage for its assigned name (assign a name to a Command block using an Anvil). More than one Command block with the same name (so mapping to the same Mage) may cause overlap issues with cooldowns or other persistent Spell data.
- A CommandSender. Any other CommandSender, such as from the server console, will map to a global "COMMAND" mage.
The COMMAND Mage has no Location, so is generally limited in what it can cast unless the "p" location parameters are used, e.g. cast blast pworld world px 0 py 70 pz 0
This will case "blast" in the center of the world "world" using the "COMMAND" Mage.
Some Spell implementations will absolutely require a Player (such as StashSpell), and so will always fail unless cast by a player or with "castp".

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateClasses()` Restores any attributes managed by unlocked classes.
`void`	`activateGUI(GUIAction action, org.bukkit.inventory.Inventory inventory)`
`void`	`activateModifiers()`
`void`	`activateSpell(Spell spell)` Set a Spell as "active".
`boolean`	`addBatch(Batch batch)`
`void`	`addCurrency(String type, double delta)`
`void`	`addCurrency(String type, double delta, boolean quiet)`
`boolean`	`addModifier(String key)`
`boolean`	`addModifier(String key, org.bukkit.configuration.ConfigurationSection properties)`
`boolean`	`addModifier(String key, int duration)`
`boolean`	`addModifier(String key, int duration, org.bukkit.configuration.ConfigurationSection properties)`
`void`	`addSkillPoints(int delta)`
`void`	`addTag(String tag)`
`boolean`	`addToStoredInventory(org.bukkit.inventory.ItemStack itemStack)`
`void`	`addUndoBatch(UndoBatch batch)`
`boolean`	`addVaultCurrency(double delta)`
`boolean`	`allowContainerCopy()`
`void`	`attributesUpdated()` Notify this Mage that it has had some attributes updated.
`Batch`	`cancelPending()` Cancel any pending construction batches.
`Batch`	`cancelPending(boolean force)`
`Batch`	`cancelPending(String spellKey)`
`Batch`	`cancelPending(String spellKey, boolean force)`
`Batch`	`cancelPending(String spellKey, boolean force, boolean nonBatched)`
`boolean`	`canCraft(String recipeKey)`
`boolean`	`canUse(org.bukkit.inventory.ItemStack item)`
`void`	`castMessage(String message)` Send a message to this Mage.
`Wand`	`checkWand()` Force a re-check of the current active wand vs the item the player is holding.
`void`	`clearCooldown()`
`void`	`clearFallProtection()`
`void`	`clearSuperProtection()`
`boolean`	`commit()` Commit this Mage's UndoQueue.
`boolean`	`consumeBlock(MaterialAndData block, boolean allowVariants)`
`void`	`continueGUI(GUIAction action, org.bukkit.inventory.Inventory inventory)`
`void`	`damagedBy(org.bukkit.entity.Entity enity, double damage)`
`void`	`deactivate()`
`void`	`deactivateAllSpells()` Deactivate all active spells for this Mage.
`void`	`deactivateAllSpells(boolean force, boolean quiet)`
`void`	`deactivateAllSpells(boolean force, boolean quiet, String exceptSpellKey)`
`void`	`deactivateClasses()` This will remove any entity attributes added by unlocked classes.
`void`	`deactivateGUI()`
`void`	`deactivateModifiers()`
`void`	`deactivateSpell(Spell spell)` Deactivate a currently active spell.
`void`	`debugBrain(org.bukkit.command.CommandSender sender)`
`void`	`debugPermissions(org.bukkit.command.CommandSender sender, Spell spell)`
`void`	`disable()`
`void`	`enableFallProtection(int ms)`
`void`	`enableFallProtection(int ms, int count, Spell protector)`
`void`	`enableFallProtection(int ms, Spell protector)`
`void`	`enableSuperProtection(int ms)`
`Wand`	`findWand(String template)` Find a wand with a particular template in the Mage's inventory.
`int`	`finishPendingUndo()`
`MageClass`	`getActiveClass()`
`GUIAction`	`getActiveGUI()`
`CasterProperties`	`getActiveProperties()` This will return properties for the mage's active wand, if holding one, or if not then the active class.
`Set<Spell>`	`getActiveSpells()`
`Wand`	`getActiveWand()` Get the active Wand being used by this Mage.
`Double`	`getAttribute(String attributeKey)`
`Wand`	`getBoundWand(String template)` Get a bound wand.
`WandUpgradePath`	`getBoundWandPath(String templateKey)`
`List<? extends Wand>`	`getBoundWands()`
`MaterialBrush`	`getBrush()`
`CasterProperties`	`getCasterProperties(String propertyType)`
`org.bukkit.Location`	`getCastLocation()` Gets the source location of spells cast by this mage, which were not cast with a wand.
`MageClass`	`getClass(String key)`
`Collection<MageClass>`	`getClasses()`
`Collection<String>`	`getClassKeys()`
`ClientPlatform`	`getClientPlatform()`
`org.bukkit.command.CommandSender`	`getCommandSender()` Get the CommandSender backed by this Mage.
`float`	`getConstructionMultiplier()`
`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
`long`	`getCreatedTime()`
`double`	`getCurrency(String type)`
`float`	`getDamageMultiplier()` Returns power-based damage combined with overall damage multipliers.
`double`	`getDamageMultiplier(String damageType)` Returns the combination of power-based damage multiplier, overall damage multiplier, and type-specific damage multiplier.
`Collection<org.bukkit.entity.Entity>`	`getDamagers()`
`org.bukkit.configuration.ConfigurationSection`	`getData()`
`org.bukkit.command.CommandSender`	`getDebugger()`
`int`	`getDebugLevel()`
`org.bukkit.util.Vector`	`getDirection()` Get the direction this Mage is facing.
`String`	`getDisplayName()`
`float`	`getEarnMultiplier()` Deprecated. Specify a currency, use "sp" for spell points
`double`	`getEarnMultiplier(String currency)`
`org.bukkit.Color`	`getEffectColor()`
`int`	`getEffectiveManaMax()`
`int`	`getEffectiveManaRegeneration()`
`String`	`getEffectParticleName()`
`org.bukkit.entity.Entity`	`getEntity()` Get the Entity instance backed by this Mage.
`EntityData`	`getEntityData()`
`int`	`getExperience()`
`org.bukkit.Location`	`getEyeLocation()` Get the eye location of this Mage.
`double`	`getHealth()`
`String`	`getId()` Get the unique id of this mage.
`org.bukkit.inventory.Inventory`	`getInventory()`
`org.bukkit.inventory.ItemStack`	`getItem(int slot)`
`int`	`getItemCount(org.bukkit.inventory.ItemStack item)`
`int`	`getItemCount(org.bukkit.inventory.ItemStack item, boolean allowDamaged)`
`org.bukkit.block.Block`	`getLastBlockBroken()`
`double`	`getLastBowPull()`
`double`	`getLastDamage()`
`double`	`getLastDamageDealt()`
`String`	`getLastDamageDealtType()`
`org.bukkit.entity.Entity`	`getLastDamager()`
`org.bukkit.entity.Entity`	`getLastDamageTarget()`
`String`	`getLastDamageType()` Get the last damage type done to this Mage.
`org.bukkit.Location`	`getLastDeathLocation()`
`double`	`getLastFallDistance()`
`int`	`getLastHeldMapId()`
`org.bukkit.entity.EntityType`	`getLastProjectileType()`
`Long`	`getLastTrigger(String trigger)`
`UndoList`	`getLastUndoList()`
`int`	`getLevel()`
`org.bukkit.entity.LivingEntity`	`getLivingEntity()` Get the LivingEntity instance backed by this Mage.
`org.bukkit.Location`	`getLocation()` Get the location of this Mage.
`List<LostWand>`	`getLostWands()`
`float`	`getMagePowerBonus()`
`float`	`getMana()`
`int`	`getManaMax()`
`int`	`getManaRegeneration()`
`double`	`getMaxHealth()`
`MageModifier`	`getModifier(String key)`
`Set<String>`	`getModifierKeys()`
`String`	`getName()` Get the name of this mage.
`Wand`	`getOffhandWand()`
`org.bukkit.Location`	`getOffhandWandLocation()`
`List<CastParameter>`	`getOverrides(String spellKey)`
`Collection<Batch>`	`getPendingBatches()` Return the list of pending construction batches for this Mage.
`org.bukkit.entity.Player`	`getPlayer()` Get the Player instance backed by this Mage.
`float`	`getPower()`
`float`	`getPowerMultiplier()`
`String`	`getPreferredResourcePack()`
`CasterProperties`	`getProperties()`
`float`	`getRadiusMultiplier()`
`float`	`getRangeMultiplier()`
`long`	`getRemainingCooldown()`
`Set<org.bukkit.Material>`	`getRestrictedMaterials()` Deprecated.
`MaterialSet`	`getRestrictedMaterialSet()`
`int`	`getSkillPoints()`
`Wand`	`getSoulWand()` Deprecated.
`MageSpell`	`getSpell(String key)` Return a Spell for this Mage, which can be used to programatically cast or modify a Spell on behalf of this Mage.
`Collection<Spell>`	`getSpells()` Return all of the Spell objects registered to this Mage.
`float`	`getSPMultiplier()` Deprecated. Use getEarnMultiplier instead.
`org.bukkit.entity.Entity`	`getTopDamager()`
`UndoQueue`	`getUndoQueue()`
`org.bukkit.configuration.ConfigurationSection`	`getVariables()`
`double`	`getVaultBalance()`
`double`	`getVehicleMovementDirection()` This method returns a positive number if the player is moving forward while in a vehicle, negative if moving backward.
`double`	`getVehicleStrafeDirection()` This method returns a positive number if the player is strafing right while in a vehicle, negative if strafing left.
`org.bukkit.util.Vector`	`getVelocity()` Return the current movement vector of this entity, in blocks per second.
`org.bukkit.Location`	`getWandLocation()` Currently returns the cast location, even when not holding a wand, but this behavior is subject to change and in the future this may return null if the Mage is not holding a Wand.
`void`	`giveExperience(int xp)`
`void`	`giveItem(org.bukkit.inventory.ItemStack item)`
`void`	`giveItem(org.bukkit.inventory.ItemStack item, boolean putInHand)`
`boolean`	`giveItem(org.bukkit.inventory.ItemStack item, boolean putInHand, boolean allowDropping)`
`boolean`	`hasBreakPermission(org.bukkit.block.Block block)`
`boolean`	`hasBuildPermission(org.bukkit.block.Block block)`
`boolean`	`hasCastPermission(Spell spell)`
`boolean`	`hasClassUnlocked(String key)`
`boolean`	`hasItem(org.bukkit.inventory.ItemStack item)`
`boolean`	`hasItem(org.bukkit.inventory.ItemStack item, boolean allowVariants)`
`boolean`	`hasLocation()`
`boolean`	`hasModifier(String key)`
`boolean`	`hasPending()`
`boolean`	`hasResourcePack()`
`boolean`	`hasSpell(String key)` Check to see if this Mage has a certain spell, generally meaning they have cast it at least once.
`boolean`	`hasStoredInventory()`
`boolean`	`hasTag(String tag)`
`boolean`	`isAtMaxCurrency(String type)`
`boolean`	`isAtMaxSkillPoints()`
`boolean`	`isAutomaton()`
`boolean`	`isBlocked(double angle)`
`boolean`	`isBypassEnabled()`
`boolean`	`isConsumeFree()`
`boolean`	`isCooldownFree()` Check if cooldowns should be bypassed completely.
`boolean`	`isCostFree()`
`boolean`	`isDead()`
`boolean`	`isDestructible(org.bukkit.block.Block block)`
`boolean`	`isGlidingAllowed()`
`boolean`	`isIgnoredByMobs()`
`boolean`	`isIndestructible(org.bukkit.block.Block block)`
`boolean`	`isJumping()`
`boolean`	`isLaunchingProjectile()`
`boolean`	`isLoading()`
`boolean`	`isOnline()`
`boolean`	`isPlayer()`
`boolean`	`isPVPAllowed(org.bukkit.Location location)`
`boolean`	`isQuiet()`
`boolean`	`isReflected(double angle)`
`boolean`	`isResourcePackEnabled()`
`boolean`	`isRestricted(org.bukkit.Material material)`
`boolean`	`isRestricted(org.bukkit.Material material, Short data)`
`boolean`	`isSneaking()`
`boolean`	`isStealth()`
`boolean`	`isSuperPowered()`
`boolean`	`isSuperProtected()`
`boolean`	`isUrlIconsEnabled()`
`boolean`	`isValid()`
`boolean`	`isVanished()`
`boolean`	`isVehicleJumping()` Check to see if a player is trying to jump while in a vehicle
`boolean`	`load(MageData data)`
`boolean`	`lockClass(String key)`
`void`	`onCast(Spell spell, SpellResult result)` This should be called by a Spell upon casting, to notify the Mage that it cast a spell.
`String`	`parameterize(String text)`
`String`	`parameterize(String command, String prefix)` Deprecated.
`String`	`parameterizeMessage(String command)` Deprecated.
`void`	`playSoundEffect(SoundEffect sound)`
`boolean`	`prepareForUndo(UndoList blocks)`
`void`	`reduceRemainingCooldown(long ms)`
`void`	`refundBlock(MaterialAndData block)`
`void`	`registerEvent(SpellEventType type, org.bukkit.event.Listener spell)`
`boolean`	`registerForUndo(UndoList blocks)`
`boolean`	`removeClass(String key)`
`void`	`removeCurrency(String type, double delta)`
`void`	`removeCurrency(String type, double delta, boolean quiet)`
`void`	`removed()`
`void`	`removeExperience(int xp)`
`int`	`removeItem(org.bukkit.inventory.ItemStack item)`
`int`	`removeItem(org.bukkit.inventory.ItemStack item, boolean allowVariants)`
`void`	`removeItemsWithTag(String tag)`
`void`	`removeMana(float mana)`
`MageModifier`	`removeModifier(String key)`
`boolean`	`removeVaultCurrency(double delta)`
`boolean`	`restoreWand()`
`boolean`	`save(MageData data)`
`void`	`sendDebugMessage(String message)`
`void`	`sendDebugMessage(String message, int level)`
`void`	`sendMessage(String message)` Send a message to this Mage.
`boolean`	`setActiveClass(String key)` Sets the active class.
`void`	`setArmorItem(int armorSlot, org.bukkit.inventory.ItemStack item)`
`void`	`setBypassEnabled(boolean enable)`
`void`	`setCooldownFree(boolean cooldownFree)`
`void`	`setCostFree(boolean costFree)`
`void`	`setCurrency(String type, double amount)`
`void`	`setDebugger(org.bukkit.command.CommandSender debugger)`
`void`	`setDebugLevel(int level)`
`void`	`setGlidingAllowed(boolean allow)`
`boolean`	`setItem(int slot, org.bukkit.inventory.ItemStack item)`
`void`	`setLastDamageDealtType(String damageType)`
`void`	`setLastDamageType(String damageType)` Set the damage type that was last given to a Mage.
`void`	`setLaunchingProjectile(boolean launching)` Set this when launching vanilla projectiles, if you don't want the launch intercepted by the bow/wand handler.
`void`	`setLevel(int level)`
`void`	`setLocation(org.bukkit.Location location)`
`void`	`setMagePowerBonus(float magePowerBonus)`
`void`	`setMana(float mana)`
`void`	`setPowerMultiplier(float power)`
`void`	`setQuiet(boolean quiet)`
`void`	`setRemainingCooldown(long ms)`
`void`	`setSkillPoints(int sp)`
`void`	`setTarget(org.bukkit.entity.Entity entity)`
`void`	`setVanished(boolean vanished)`
`void`	`showHoloText(org.bukkit.Location location, String text, int duration)` Deprecated.
`void`	`tick()`
`boolean`	`toggleSpellEnabled(String spellKey)`
`boolean`	`trigger(String trigger)`
`boolean`	`tryGiveItem(org.bukkit.inventory.ItemStack item)` Will not drop the item on the ground, unlike giveItem
`boolean`	`tryGiveItem(org.bukkit.inventory.ItemStack item, boolean putInHand)`
`boolean`	`tryToOwn(Wand wand)`
`boolean`	`unbind(String template)`
`void`	`unbind(Wand wand)`
`void`	`unbindAll()`
`UndoList`	`undo()` Undo the last construction performed by this Mage.
`UndoList`	`undo(org.bukkit.block.Block block)` Undo the last construction performed by this Mage against the given Block
`void`	`undoScheduled()`
`void`	`undoScheduled(String spellKey)`
`MageClass`	`unlockClass(String key)`
`void`	`unregisterEvent(SpellEventType type, org.bukkit.event.Listener spell)`
`void`	`updateMana()`
`void`	`updatePassiveEffects()`

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

- Method Detail
  - getPendingBatches
```
Collection<Batch> getPendingBatches()
```
    Return the list of pending construction batches for this Mage.
    
    Returns:
    
    Pending construction batches
  - getName
```
String getName()
```
    Get the name of this mage. This may be the Player's display name, or the name of a command block (for Automata)
    
    Returns:
    
    String the display name of this mage
  - getDisplayName
```
String getDisplayName()
```
  - getId
```
String getId()
```
    Get the unique id of this mage. May be a UUID for a player, or a command block name for Automata.
    
    Returns:
    
    String the unique id of this Mage
  - getLocation
```
org.bukkit.Location getLocation()
```
    Get the location of this Mage. This may be a Player location, a Command block location, or null for console casting.
    
    Returns:
    
    Location the location of this Mage.
  - getEyeLocation
```
org.bukkit.Location getEyeLocation()
```
    Get the eye location of this Mage. May be the Player eye location, or the Location of the Mage plus 1.5 y.
    
    Returns:
    
    Location the location of the Mage's eyes, used for targeting.
  - getCastLocation
```
@Nullable
org.bukkit.Location getCastLocation()
```
    Gets the source location of spells cast by this mage, which were not cast with a wand.
    
    Returns:
    
    the location
  - getWandLocation
```
@Nullable
org.bukkit.Location getWandLocation()
```
    Currently returns the cast location, even when not holding a wand, but this behavior is subject to change and in the future this may return null if the Mage is not holding a Wand.
    
    Returns:
    
    the location
  - getOffhandWandLocation
```
@Nullable
org.bukkit.Location getOffhandWandLocation()
```
  - getDirection
```
org.bukkit.util.Vector getDirection()
```
    Get the direction this Mage is facing.
    
    Returns:
    
    Vector the facing direction
  - getPlayer
```
@Nullable
org.bukkit.entity.Player getPlayer()
```
    Get the Player instance backed by this Mage.
    This may return null for Command block or console-based mages.
    A Spell should detect this and, if the Spell absolutely requires a Player, should return SpellResult.PLAYER_REQUIRED.
    Spells should attempt to avoid requiring a player, do not use the Player object to get a Location or Vector direction, generally try to use the Spell or Mage methods for that. This will make sure that parameter overrides and command-block usage function properly.
    A Player should only be needed if a Spell does something very Player-specific, such as open an inventory to show the Player in-game, like StashSpell does.
    
    Returns:
    
    The player backed by this Mage, or null for Automaton Mages.
  - getEntity
```
org.bukkit.entity.Entity getEntity()
```
    Get the Entity instance backed by this Mage.
    This may be a Player or other Entity, or null in the case of a CommandSender-based Mage, like an Automaton.
    
    Returns:
    
    The Entity represented by this Mage
  - getLivingEntity
```
@Nullable
org.bukkit.entity.LivingEntity getLivingEntity()
```
    Get the LivingEntity instance backed by this Mage.
    This is basically a helper wrapper for getEntity that does a typecheck for you.
    
    Returns:
    
    The LivingEntity represented by this Mage
  - getCommandSender
```
org.bukkit.command.CommandSender getCommandSender()
```
    Get the CommandSender backed by this Mage.
    This should generally always be non-null, and can be used to send a message to the Mage. This may show in the server console, Player chat, or get eaten by a Command block.
    
    Returns:
    
    CommandSender The sender driving this Mage.
  - sendMessage
```
void sendMessage(String message)
```
    Send a message to this Mage.
    This will respect the global plugin message cooldown, message display settings and the Mage's active Wand "quiet" setting.
    A Wand "quiet" setting of 2 will disable these messages.
    
    Parameters:
    
    message - The message to send.
  - sendDebugMessage
```
void sendDebugMessage(String message)
```
  - sendDebugMessage
```
void sendDebugMessage(String message,
                      int level)
```
  - castMessage
```
void castMessage(String message)
```
    Send a message to this Mage.
    This will respect the global plugin "cast" message cooldown, message display settings and the Mage's active Wand "quiet" setting.
    A Wand "quiet" setting of 1 will disable these messages.
    
    Parameters:
    
    message - The message to send.
  - cancelPending
```
@Nullable
Batch cancelPending()
```
    Cancel any pending construction batches.
    
    Returns:
    
    The batch that was cancelled, or null if nothing was pending.
  - cancelPending
```
@Nullable
Batch cancelPending(String spellKey)
```
  - cancelPending
```
@Nullable
Batch cancelPending(boolean force)
```
  - cancelPending
```
@Nullable
Batch cancelPending(String spellKey,
                              boolean force)
```
  - cancelPending
```
@Nullable
Batch cancelPending(String spellKey,
                              boolean force,
                              boolean nonBatched)
```
  - undo
```
@Nullable
UndoList undo()
```
    Undo the last construction performed by this Mage.
    This will restore anything changed by the last-cast construction spell, and remove that construction from the Mage's UndoQueue.
    
    Returns:
    
    The UndoList that was undone, or null if none.
  - undo
```
@Nullable
UndoList undo(org.bukkit.block.Block block)
```
    Undo the last construction performed by this Mage against the given Block
    This will restore anything changed by the last-cast construction spell by this Mage that targeted the specific Block, even if it was not the most recent Spell cast by that Mage.
    
    Parameters:
    
    block - The block to check for modifications.
    
    Returns:
    
    The UndoList that was undone, or null if the Mage has no constructions for the given Block.
  - commit
```
boolean commit()
```
    Commit this Mage's UndoQueue.
    This will cause anything in the undo queue to become permanent- meaning other overlapping spells won't undo this construction, even if they were cast before the spells in this undo queue.
    This also clears the Mage's undo queue, which may allow them to be destroyed if they are no longer active (e.g. the Player logged out).
    This has no effect on the Mage's scheduled undo batches.
    
    Returns:
    
    True if anything was commited, false if the Mage has no undo queue.
  - getActiveWand
```
Wand getActiveWand()
```
    Get the active Wand being used by this Mage.
    This will generally be the Wand represented by the ItemStack held by the Player this Mage represents.
    Automata and other non-Player Mages generally do not have Wands.
    
    Returns:
    
    The Mage's active Wand.
  - getOffhandWand
```
Wand getOffhandWand()
```
  - getActiveGUI
```
GUIAction getActiveGUI()
```
  - findWand
```
@Nullable
Wand findWand(@Nonnull
                        String template)
```
    Find a wand with a particular template in the Mage's inventory. If the Mage has more than one of this type of wand, only the first will be returned.
    
    Returns:
    
    A wand found in the player's inventory that matches template, or null if none found.
  - getBoundWand
```
Wand getBoundWand(String template)
```
    Get a bound wand. Bound wands are stored based on their template, only one wand per template type is stored.
  - getBoundWands
```
List<? extends Wand> getBoundWands()
```
    Returns:
    
    An immutable list of bound wands.
  - checkWand
```
@Nullable
Wand checkWand()
```
    Force a re-check of the current active wand vs the item the player is holding.
    This may activate or deactivate a wand, or both.
    
    Returns:
    
    The current active wand, after checking
  - getSpell
```
@Nullable
MageSpell getSpell(String key)
```
    Return a Spell for this Mage, which can be used to programatically cast or modify a Spell on behalf of this Mage.
    This will create and register the spell if the Mage has never cast it, but has permission to do so.
    
    Parameters:
    
    key - The key of the Spell to retrieve.
    
    Returns:
    
    The Spell instance for this Mage, or null if the Mage does not have access to this Spell.
  - hasSpell
```
boolean hasSpell(String key)
```
    Check to see if this Mage has a certain spell, generally meaning they have cast it at least once.
    
    Parameters:
    
    key - The spell key
    
    Returns:
    
    True if the Mage has ever cast this spell
  - getSpells
```
Collection<Spell> getSpells()
```
    Return all of the Spell objects registered to this Mage.
    This will generally be any Spells the Mage has ever cast.
    
    Returns:
    
    A Collection of Spell objects this Mage has cast.
  - activateSpell
```
void activateSpell(Spell spell)
```
    Set a Spell as "active". An "active" spell is generally a toggleable on/off spell. These spells may be draining mana/xp while they are active, and may self-deactivate after a specific duration, or if their resources deplete.
    
    Parameters:
    
    spell - The spell to activate.
  - deactivateSpell
```
void deactivateSpell(Spell spell)
```
    Deactivate a currently active spell. A spell may call this to deactivate itself.
    If the given spell is not currently active, nothing will happen.
    
    Parameters:
    
    spell - The spell to deactivate
  - deactivateAllSpells
```
void deactivateAllSpells()
```
    Deactivate all active spells for this Mage.
  - deactivateAllSpells
```
void deactivateAllSpells(boolean force,
                         boolean quiet)
```
  - deactivateAllSpells
```
void deactivateAllSpells(boolean force,
                         boolean quiet,
                         String exceptSpellKey)
```
  - getData
```
org.bukkit.configuration.ConfigurationSection getData()
```
  - isCooldownFree
```
boolean isCooldownFree()
```
    Description copied from interface: CooldownReducer
    
    Check if cooldowns should be bypassed completely.
    
    Specified by:
    
    isCooldownFree in interface CooldownReducer
    
    Returns:
    
    True if cooldowns are disabled
  - 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.
  - isCostFree
```
boolean isCostFree()
```
    Specified by:
    
    isCostFree in interface CostReducer
  - isConsumeFree
```
boolean isConsumeFree()
```
    Specified by:
    
    isConsumeFree in interface CostReducer
  - setCostFree
```
void setCostFree(boolean costFree)
```
  - setCooldownFree
```
void setCooldownFree(boolean cooldownFree)
```
  - 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.
  - getRemainingCooldown
```
long getRemainingCooldown()
```
  - setRemainingCooldown
```
void setRemainingCooldown(long ms)
```
  - reduceRemainingCooldown
```
void reduceRemainingCooldown(long ms)
```
  - clearCooldown
```
void clearCooldown()
```
  - isSuperPowered
```
boolean isSuperPowered()
```
  - isSuperProtected
```
boolean isSuperProtected()
```
  - isIgnoredByMobs
```
boolean isIgnoredByMobs()
```
  - getRangeMultiplier
```
float getRangeMultiplier()
```
  - getRadiusMultiplier
```
float getRadiusMultiplier()
```
  - getConstructionMultiplier
```
float getConstructionMultiplier()
```
  - getDamageMultiplier
```
double getDamageMultiplier(String damageType)
```
    Returns the combination of power-based damage multiplier, overall damage multiplier, and type-specific damage multiplier.
    
    Returns:
    
    the multiplier
  - getDamageMultiplier
```
float getDamageMultiplier()
```
    Returns power-based damage combined with overall damage multipliers.
    
    Returns:
    
    the multiplier
  - getEffectColor
```
@Nullable
org.bukkit.Color getEffectColor()
```
  - getEffectParticleName
```
@Nullable
String getEffectParticleName()
```
  - getPower
```
float getPower()
```
  - getPowerMultiplier
```
float getPowerMultiplier()
```
  - setPowerMultiplier
```
void setPowerMultiplier(float power)
```
  - getMagePowerBonus
```
float getMagePowerBonus()
```
  - setMagePowerBonus
```
void setMagePowerBonus(float magePowerBonus)
```
  - isPlayer
```
boolean isPlayer()
```
  - isOnline
```
boolean isOnline()
```
  - isDead
```
boolean isDead()
```
  - isLoading
```
boolean isLoading()
```
  - hasLocation
```
boolean hasLocation()
```
  - disable
```
void disable()
```
  - setLocation
```
void setLocation(org.bukkit.Location location)
```
  - onCast
```
void onCast(Spell spell,
            SpellResult result)
```
    This should be called by a Spell upon casting, to notify the Mage that it cast a spell.
    
    Parameters:
    
    spell - The Spell that was cast
    
    result - The result of the cast.
  - isRestricted
```
boolean isRestricted(org.bukkit.Material material)
```
  - isRestricted
```
boolean isRestricted(org.bukkit.Material material,
                     @Nullable
                     Short data)
```
  - getRestrictedMaterials
```
@Nullable
 @Deprecated
Set<org.bukkit.Material> getRestrictedMaterials()
```
    Deprecated.
  - getRestrictedMaterialSet
```
MaterialSet getRestrictedMaterialSet()
```
  - getController
```
MageController getController()
```
  - hasCastPermission
```
boolean hasCastPermission(Spell spell)
```
  - hasBuildPermission
```
boolean hasBuildPermission(org.bukkit.block.Block block)
```
  - hasBreakPermission
```
boolean hasBreakPermission(org.bukkit.block.Block block)
```
  - isPVPAllowed
```
boolean isPVPAllowed(org.bukkit.Location location)
```
  - isIndestructible
```
boolean isIndestructible(org.bukkit.block.Block block)
```
  - isDestructible
```
boolean isDestructible(org.bukkit.block.Block block)
```
  - registerForUndo
```
boolean registerForUndo(UndoList blocks)
```
  - prepareForUndo
```
boolean prepareForUndo(UndoList blocks)
```
  - getInventory
```
@Nullable
org.bukkit.inventory.Inventory getInventory()
```
  - removeItem
```
int removeItem(org.bukkit.inventory.ItemStack item)
```
  - removeItem
```
int removeItem(org.bukkit.inventory.ItemStack item,
               boolean allowVariants)
```
  - hasItem
```
boolean hasItem(org.bukkit.inventory.ItemStack item)
```
  - hasItem
```
boolean hasItem(org.bukkit.inventory.ItemStack item,
                boolean allowVariants)
```
  - consumeBlock
```
boolean consumeBlock(MaterialAndData block,
                     boolean allowVariants)
```
  - refundBlock
```
void refundBlock(MaterialAndData block)
```
  - getItemCount
```
int getItemCount(org.bukkit.inventory.ItemStack item,
                 boolean allowDamaged)
```
  - getItemCount
```
int getItemCount(org.bukkit.inventory.ItemStack item)
```
  - getItem
```
@Nullable
org.bukkit.inventory.ItemStack getItem(int slot)
```
  - setItem
```
boolean setItem(int slot,
                org.bukkit.inventory.ItemStack item)
```
  - getBrush
```
MaterialBrush getBrush()
```
  - removeExperience
```
void removeExperience(int xp)
```
  - getExperience
```
int getExperience()
```
  - giveExperience
```
void giveExperience(int xp)
```
  - removeMana
```
void removeMana(float mana)
```
  - getMana
```
float getMana()
```
  - getManaMax
```
int getManaMax()
```
  - getEffectiveManaMax
```
int getEffectiveManaMax()
```
  - setMana
```
void setMana(float mana)
```
  - getManaRegeneration
```
int getManaRegeneration()
```
  - getEffectiveManaRegeneration
```
int getEffectiveManaRegeneration()
```
  - updateMana
```
void updateMana()
```
  - getLevel
```
int getLevel()
```
  - setLevel
```
void setLevel(int level)
```
  - addBatch
```
boolean addBatch(Batch batch)
```
  - addUndoBatch
```
void addUndoBatch(UndoBatch batch)
```
  - registerEvent
```
void registerEvent(SpellEventType type,
                   org.bukkit.event.Listener spell)
```
  - unregisterEvent
```
void unregisterEvent(SpellEventType type,
                     org.bukkit.event.Listener spell)
```
  - getUndoQueue
```
UndoQueue getUndoQueue()
```
  - finishPendingUndo
```
int finishPendingUndo()
```
  - getLostWands
```
List<LostWand> getLostWands()
```
  - getLastDeathLocation
```
org.bukkit.Location getLastDeathLocation()
```
  - hasStoredInventory
```
boolean hasStoredInventory()
```
  - addToStoredInventory
```
boolean addToStoredInventory(org.bukkit.inventory.ItemStack itemStack)
```
  - getActiveSpells
```
Set<Spell> getActiveSpells()
```
  - enableFallProtection
```
void enableFallProtection(int ms)
```
  - enableFallProtection
```
void enableFallProtection(int ms,
                          @Nullable
                          Spell protector)
```
  - enableFallProtection
```
void enableFallProtection(int ms,
                          int count,
                          @Nullable
                          Spell protector)
```
  - clearFallProtection
```
void clearFallProtection()
```
  - enableSuperProtection
```
void enableSuperProtection(int ms)
```
  - clearSuperProtection
```
void clearSuperProtection()
```
  - load
```
boolean load(MageData data)
```
  - save
```
boolean save(MageData data)
```
  - deactivate
```
void deactivate()
```
  - isValid
```
boolean isValid()
```
  - hasPending
```
boolean hasPending()
```
  - restoreWand
```
boolean restoreWand()
```
  - getLastUndoList
```
@Nullable
UndoList getLastUndoList()
```
  - isStealth
```
boolean isStealth()
```
  - isSneaking
```
boolean isSneaking()
```
  - isJumping
```
boolean isJumping()
```
  - removed
```
void removed()
```
  - tick
```
void tick()
```
  - activateGUI
```
void activateGUI(GUIAction action,
                 org.bukkit.inventory.Inventory inventory)
```
  - continueGUI
```
void continueGUI(GUIAction action,
                 org.bukkit.inventory.Inventory inventory)
```
  - deactivateGUI
```
void deactivateGUI()
```
  - playSoundEffect
```
void playSoundEffect(SoundEffect sound)
```
  - showHoloText
```
@Deprecated
void showHoloText(org.bukkit.Location location,
                              String text,
                              int duration)
```
    Deprecated.
  - getDebugLevel
```
int getDebugLevel()
```
  - setDebugLevel
```
void setDebugLevel(int level)
```
  - setDebugger
```
void setDebugger(org.bukkit.command.CommandSender debugger)
```
  - debugBrain
```
void debugBrain(org.bukkit.command.CommandSender sender)
```
  - debugPermissions
```
void debugPermissions(org.bukkit.command.CommandSender sender,
                      Spell spell)
```
  - getDebugger
```
org.bukkit.command.CommandSender getDebugger()
```
  - giveItem
```
void giveItem(org.bukkit.inventory.ItemStack item)
```
  - giveItem
```
void giveItem(org.bukkit.inventory.ItemStack item,
              boolean putInHand)
```
  - giveItem
```
boolean giveItem(org.bukkit.inventory.ItemStack item,
                 boolean putInHand,
                 boolean allowDropping)
```
  - setArmorItem
```
void setArmorItem(int armorSlot,
                  org.bukkit.inventory.ItemStack item)
```
  - tryGiveItem
```
boolean tryGiveItem(org.bukkit.inventory.ItemStack item)
```
    Will not drop the item on the ground, unlike giveItem
  - tryGiveItem
```
boolean tryGiveItem(org.bukkit.inventory.ItemStack item,
                    boolean putInHand)
```
  - removeItemsWithTag
```
void removeItemsWithTag(String tag)
```
  - setQuiet
```
void setQuiet(boolean quiet)
```
  - isQuiet
```
boolean isQuiet()
```
  - getSkillPoints
```
int getSkillPoints()
```
  - addSkillPoints
```
void addSkillPoints(int delta)
```
  - setSkillPoints
```
void setSkillPoints(int sp)
```
  - isAtMaxSkillPoints
```
boolean isAtMaxSkillPoints()
```
  - getCurrency
```
double getCurrency(String type)
```
  - addCurrency
```
void addCurrency(String type,
                 double delta)
```
  - addCurrency
```
void addCurrency(String type,
                 double delta,
                 boolean quiet)
```
  - removeCurrency
```
void removeCurrency(String type,
                    double delta)
```
  - removeCurrency
```
void removeCurrency(String type,
                    double delta,
                    boolean quiet)
```
  - setCurrency
```
void setCurrency(String type,
                 double amount)
```
  - isAtMaxCurrency
```
boolean isAtMaxCurrency(String type)
```
  - getBoundWandPath
```
@Nullable
WandUpgradePath getBoundWandPath(String templateKey)
```
  - unbind
```
boolean unbind(String template)
```
  - unbind
```
void unbind(Wand wand)
```
  - unbindAll
```
void unbindAll()
```
  - undoScheduled
```
void undoScheduled()
```
  - undoScheduled
```
void undoScheduled(String spellKey)
```
  - getEntityData
```
EntityData getEntityData()
```
  - tryToOwn
```
boolean tryToOwn(Wand wand)
```
  - isReflected
```
boolean isReflected(double angle)
```
  - isBlocked
```
boolean isBlocked(double angle)
```
  - getLastHeldMapId
```
int getLastHeldMapId()
```
  - getClasses
```
@Nonnull
Collection<MageClass> getClasses()
```
  - getClassKeys
```
@Nonnull
Collection<String> getClassKeys()
```
  - getActiveClass
```
@Nullable
MageClass getActiveClass()
```
  - unlockClass
```
@Nullable
MageClass unlockClass(@Nonnull
                                String key)
```
  - lockClass
```
boolean lockClass(@Nonnull
                  String key)
```
  - getClass
```
@Nullable
MageClass getClass(@Nonnull
                             String key)
```
  - hasClassUnlocked
```
boolean hasClassUnlocked(@Nonnull
                         String key)
```
  - damagedBy
```
void damagedBy(@Nonnull
               org.bukkit.entity.Entity enity,
               double damage)
```
  - getDamagers
```
@Nullable
Collection<org.bukkit.entity.Entity> getDamagers()
```
  - getLastDamager
```
@Nullable
org.bukkit.entity.Entity getLastDamager()
```
  - getTopDamager
```
@Nullable
org.bukkit.entity.Entity getTopDamager()
```
  - getLastDamageTarget
```
@Nullable
org.bukkit.entity.Entity getLastDamageTarget()
```
  - getLastBlockBroken
```
@Nullable
org.bukkit.block.Block getLastBlockBroken()
```
  - getLastTrigger
```
@Nullable
Long getLastTrigger(String trigger)
```
  - setTarget
```
void setTarget(org.bukkit.entity.Entity entity)
```
  - getActiveProperties
```
@Nonnull
CasterProperties getActiveProperties()
```
    This will return properties for the mage's active wand, if holding one, or if not then the active class.
    If the mage has no active class, then mage properties are returned.
    
    Returns:
    
    The caster
  - getVaultBalance
```
double getVaultBalance()
```
  - addVaultCurrency
```
boolean addVaultCurrency(double delta)
```
  - removeVaultCurrency
```
boolean removeVaultCurrency(double delta)
```
  - hasTag
```
boolean hasTag(String tag)
```
  - addTag
```
void addTag(String tag)
```
  - setActiveClass
```
boolean setActiveClass(@Nullable
                       String key)
```
    Sets the active class.
    
    Parameters:
    
    key - The key of the class to set, may be null to clear it.
    
    Returns:
    
    True iff this was a valid class key.
  - removeClass
```
boolean removeClass(@Nonnull
                    String key)
```
  - getProperties
```
@Nonnull
CasterProperties getProperties()
```
  - getVehicleMovementDirection
```
double getVehicleMovementDirection()
```
    This method returns a positive number if the player is moving forward while in a vehicle, negative if moving backward.
  - getVehicleStrafeDirection
```
double getVehicleStrafeDirection()
```
    This method returns a positive number if the player is strafing right while in a vehicle, negative if strafing left.
  - isVehicleJumping
```
boolean isVehicleJumping()
```
    Check to see if a player is trying to jump while in a vehicle
    
    Returns:
    
    true if the player is pressing the spacebar while in a vehicle
  - getVelocity
```
org.bukkit.util.Vector getVelocity()
```
    Return the current movement vector of this entity, in blocks per second.
    This is a computed value, and is not the same as getEntity().getVelocity.
  - getLastFallDistance
```
double getLastFallDistance()
```
  - setVanished
```
void setVanished(boolean vanished)
```
  - isVanished
```
boolean isVanished()
```
  - setGlidingAllowed
```
void setGlidingAllowed(boolean allow)
```
  - isGlidingAllowed
```
boolean isGlidingAllowed()
```
  - getSoulWand
```
@Nullable
 @Deprecated
Wand getSoulWand()
```
    Deprecated.
    
    This method is deprecated, soul wand functionality was never implemented.
    Get the Mage's "soul" wand. This represents all of the spells and other properties that are bound to the Mage itself, rather than to a specific wand.
    This wand never appears as an in-game item.
  - isAutomaton
```
boolean isAutomaton()
```
  - getAttribute
```
@Nullable
Double getAttribute(String attributeKey)
```
  - attributesUpdated
```
void attributesUpdated()
```
    Notify this Mage that it has had some attributes updated.
    This will force a rebuild of spell parameters that may appear in lore, so that the lore will correctly reflect the new attribute values.
    This is called automatically if using setAttribute, and so should only be called if updating attributes via an external AttributeProvider.
  - setLastDamageType
```
void setLastDamageType(String damageType)
```
    Set the damage type that was last given to a Mage.
    Set this prior to damaging a mage for custom weakness/protection to work properly.
    
    Parameters:
    
    damageType - A damage type as defined in config.yml
  - getLastDamageType
```
@Nullable
String getLastDamageType()
```
    Get the last damage type done to this Mage.
    This can be a custom damage type, or the name of a vanilla type.
    
    Returns:
    
    the last damage type this Mage received.
  - setLastDamageDealtType
```
void setLastDamageDealtType(String damageType)
```
  - getLastDamageDealtType
```
@Nullable
String getLastDamageDealtType()
```
  - getLastDamage
```
double getLastDamage()
```
  - getLastDamageDealt
```
double getLastDamageDealt()
```
  - getLastBowPull
```
double getLastBowPull()
```
  - getLastProjectileType
```
org.bukkit.entity.EntityType getLastProjectileType()
```
  - getContext
```
@Nonnull
MageContext getContext()
```
  - getCreatedTime
```
long getCreatedTime()
```
  - trigger
```
boolean trigger(String trigger)
```
  - getEarnMultiplier
```
double getEarnMultiplier(String currency)
```
  - getEarnMultiplier
```
@Deprecated
float getEarnMultiplier()
```
    Deprecated. Specify a currency, use "sp" for spell points
  - getSPMultiplier
```
@Deprecated
float getSPMultiplier()
```
    Deprecated. Use getEarnMultiplier instead.
  - deactivateClasses
```
void deactivateClasses()
```
    This will remove any entity attributes added by unlocked classes. Primarily used on shutdown, in case someone removes the plugin.
  - activateClasses
```
void activateClasses()
```
    Restores any attributes managed by unlocked classes. Used on login to restore attributes.
  - deactivateModifiers
```
void deactivateModifiers()
```
  - activateModifiers
```
void activateModifiers()
```
  - setLaunchingProjectile
```
void setLaunchingProjectile(boolean launching)
```
    Set this when launching vanilla projectiles, if you don't want the launch intercepted by the bow/wand handler.
    Always make sure to unset it.
  - isLaunchingProjectile
```
boolean isLaunchingProjectile()
```
  - getHealth
```
double getHealth()
```
  - getMaxHealth
```
double getMaxHealth()
```
  - toggleSpellEnabled
```
boolean toggleSpellEnabled(String spellKey)
```
  - getVariables
```
@Nonnull
org.bukkit.configuration.ConfigurationSection getVariables()
```
  - updatePassiveEffects
```
void updatePassiveEffects()
```
  - addModifier
```
boolean addModifier(@Nonnull
                    String key)
```
  - addModifier
```
boolean addModifier(@Nonnull
                    String key,
                    @Nullable
                    org.bukkit.configuration.ConfigurationSection properties)
```
  - addModifier
```
boolean addModifier(@Nonnull
                    String key,
                    int duration)
```
  - addModifier
```
boolean addModifier(@Nonnull
                    String key,
                    int duration,
                    @Nullable
                    org.bukkit.configuration.ConfigurationSection properties)
```
  - removeModifier
```
MageModifier removeModifier(@Nonnull
                            String key)
```
  - hasModifier
```
boolean hasModifier(@Nonnull
                    String key)
```
  - getModifierKeys
```
@Nonnull
Set<String> getModifierKeys()
```
  - getModifier
```
@Nullable
MageModifier getModifier(String key)
```
  - isBypassEnabled
```
boolean isBypassEnabled()
```
  - setBypassEnabled
```
void setBypassEnabled(boolean enable)
```
  - getOverrides
```
@Nullable
List<CastParameter> getOverrides(String spellKey)
```
  - isResourcePackEnabled
```
boolean isResourcePackEnabled()
```
  - hasResourcePack
```
boolean hasResourcePack()
```
  - getPreferredResourcePack
```
@Nullable
String getPreferredResourcePack()
```
  - isUrlIconsEnabled
```
boolean isUrlIconsEnabled()
```
  - canUse
```
boolean canUse(org.bukkit.inventory.ItemStack item)
```
  - canCraft
```
boolean canCraft(String recipeKey)
```
  - parameterize
```
String parameterize(String text)
```
  - parameterize
```
@Deprecated
String parameterize(String command,
                                String prefix)
```
    Deprecated.
  - parameterizeMessage
```
@Deprecated
String parameterizeMessage(String command)
```
    Deprecated.
  - getClientPlatform
```
ClientPlatform getClientPlatform()
```
  - getCasterProperties
```
@Nullable
CasterProperties getCasterProperties(String propertyType)
```
  - allowContainerCopy
```
boolean allowContainerCopy()
```

Interface Mage

Method Summary

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

Method Detail

getPendingBatches

getName

getDisplayName

getId

getLocation

getEyeLocation

getCastLocation

getWandLocation

getOffhandWandLocation

getDirection

getPlayer

getEntity

getLivingEntity

getCommandSender

sendMessage

sendDebugMessage

sendDebugMessage

castMessage

cancelPending

cancelPending

cancelPending

cancelPending

cancelPending

undo

undo

commit

getActiveWand

getOffhandWand

getActiveGUI

findWand

getBoundWand

getBoundWands

checkWand

getSpell

hasSpell

getSpells

activateSpell

deactivateSpell

deactivateAllSpells

deactivateAllSpells

deactivateAllSpells

getData

isCooldownFree

getCooldownReduction

isCostFree

isConsumeFree

setCostFree

setCooldownFree

getCostReduction

getRemainingCooldown

setRemainingCooldown

reduceRemainingCooldown

clearCooldown

isSuperPowered

isSuperProtected

isIgnoredByMobs

getRangeMultiplier

getRadiusMultiplier

getConstructionMultiplier

getDamageMultiplier

getDamageMultiplier

getEffectColor

getEffectParticleName

getPower

getPowerMultiplier

setPowerMultiplier

getMagePowerBonus

setMagePowerBonus

isPlayer

isOnline

isDead

isLoading

hasLocation

disable

setLocation

onCast