org.bukkit.event.enchantment
Class EnchantItemEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.inventory.InventoryEvent
          extended by org.bukkit.event.enchantment.EnchantItemEvent
All Implemented Interfaces:
Cancellable

public class EnchantItemEvent
extends InventoryEvent
implements Cancellable

Called when an ItemStack is successfully enchanted (currently at enchantment table)


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Field Summary
 
Fields inherited from class org.bukkit.event.inventory.InventoryEvent
transaction
 
Constructor Summary
EnchantItemEvent(Player enchanter, InventoryView view, Block table, ItemStack item, int level, Map<Enchantment,Integer> enchants, int i)
           
 
Method Summary
 Block getEnchantBlock()
          Gets the block being used to enchant the item
 Player getEnchanter()
          Gets the player enchanting the item
 Map<Enchantment,Integer> getEnchantsToAdd()
          Get map of enchantment (levels, keyed by type) to be added to item (modify map returned to change values) Note: Any enchantments not allowed for the item will be ignored
 int getExpLevelCost()
          Get cost in exp levels of the enchantment
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 ItemStack getItem()
          Gets the item to be enchanted (can be modified)
 boolean isCancelled()
          Gets the cancellation state of this event.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 void setExpLevelCost(int level)
          Set cost in exp levels of the enchantment
 int whichButton()
          Which button was pressed to initiate the enchanting.
 
Methods inherited from class org.bukkit.event.inventory.InventoryEvent
getInventory, getView, getViewers
 
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnchantItemEvent

public EnchantItemEvent(Player enchanter,
                        InventoryView view,
                        Block table,
                        ItemStack item,
                        int level,
                        Map<Enchantment,Integer> enchants,
                        int i)
Method Detail

getEnchanter

public Player getEnchanter()
Gets the player enchanting the item

Returns:
enchanting player

getEnchantBlock

public Block getEnchantBlock()
Gets the block being used to enchant the item

Returns:
the block used for enchanting

getItem

public ItemStack getItem()
Gets the item to be enchanted (can be modified)

Returns:
ItemStack of item

getExpLevelCost

public int getExpLevelCost()
Get cost in exp levels of the enchantment

Returns:
experience level cost

setExpLevelCost

public void setExpLevelCost(int level)
Set cost in exp levels of the enchantment

Parameters:
level - - cost in levels

getEnchantsToAdd

public Map<Enchantment,Integer> getEnchantsToAdd()
Get map of enchantment (levels, keyed by type) to be added to item (modify map returned to change values) Note: Any enchantments not allowed for the item will be ignored

Returns:
map of enchantment levels, keyed by enchantment

whichButton

public int whichButton()
Which button was pressed to initiate the enchanting.

Returns:
The button index (0, 1, or 2).

isCancelled

public boolean isCancelled()
Description copied from interface: Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:
isCancelled in interface Cancellable
Returns:
true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)
Description copied from interface: Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:
setCancelled in interface Cancellable
Parameters:
cancel - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()
Overrides:
getHandlers in class InventoryEvent

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.