|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.bukkit.event.Event org.bukkit.event.inventory.InventoryEvent org.bukkit.event.inventory.InventoryInteractEvent org.bukkit.event.inventory.InventoryDragEvent
public class InventoryDragEvent
This event is called when the player drags an item in their cursor across
the inventory. The ItemStack is distributed across the slots the
HumanEntity dragged over. The method of distribution is described by the
DragType returned by getType()
.
Canceling this event will result in none of the changes described in
getNewItems()
being applied to the Inventory.
Because InventoryDragEvent occurs within a modification of the Inventory, not all Inventory related methods are safe to use.
The following should never be invoked by an EventHandler for InventoryDragEvent using the HumanEntity or InventoryView associated with this event.
HumanEntity.closeInventory()
HumanEntity.openInventory(Inventory)
HumanEntity.openWorkbench(Location, boolean)
HumanEntity.openEnchanting(Location, boolean)
InventoryView.close()
BukkitScheduler.runTask(Plugin, Runnable)
, which will run the task
on the next tick. Also be aware that this is not an exhaustive list, and
other methods could potentially create issues as well.
Assuming the EntityHuman associated with this event is an instance of a
Player, manipulating the MaxStackSize or contents of an Inventory will
require an Invocation of Player.updateInventory()
.
Any modifications to slots that are modified by the results of this
InventoryDragEvent will be overwritten. To change these slots, this event
should be cancelled and the changes applied. Alternatively, scheduling a
task using BukkitScheduler.runTask(Plugin, Runnable)
, which would
execute the task on the next tick, would work as well.
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 | |
---|---|
InventoryDragEvent(InventoryView what,
ItemStack newCursor,
ItemStack oldCursor,
boolean right,
Map<Integer,ItemStack> slots)
|
Method Summary | |
---|---|
ItemStack |
getCursor()
Gets the result cursor after the drag is done. |
static HandlerList |
getHandlerList()
|
HandlerList |
getHandlers()
|
Set<Integer> |
getInventorySlots()
Gets the slots to be changed in this drag. |
Map<Integer,ItemStack> |
getNewItems()
Gets all items to be added to the inventory in this drag. |
ItemStack |
getOldCursor()
Gets an ItemStack representing the cursor prior to any modifications as a result of this drag. |
Set<Integer> |
getRawSlots()
Gets the raw slot ids to be changed in this drag. |
DragType |
getType()
Gets the DragType that describes the behavior of ItemStacks placed after this InventoryDragEvent. |
void |
setCursor(ItemStack newCursor)
Sets the result cursor after the drag is done. |
Methods inherited from class org.bukkit.event.inventory.InventoryInteractEvent |
---|
getResult, getWhoClicked, isCancelled, setCancelled, setResult |
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 |
---|
public InventoryDragEvent(InventoryView what, ItemStack newCursor, ItemStack oldCursor, boolean right, Map<Integer,ItemStack> slots)
Method Detail |
---|
public Map<Integer,ItemStack> getNewItems()
public Set<Integer> getRawSlots()
public Set<Integer> getInventorySlots()
Inventory.getItem(int)
.public ItemStack getCursor()
public void setCursor(ItemStack newCursor)
Changing this item stack changes the cursor item. Note that changing the affected "dragged" slots does not change this ItemStack, nor does changing this ItemStack affect the "dragged" slots.
newCursor
- the new cursor ItemStackpublic ItemStack getOldCursor()
public DragType getType()
The ItemStacks and the raw slots that they're being applied to can be
found using getNewItems()
.
public HandlerList getHandlers()
getHandlers
in class InventoryEvent
public static HandlerList getHandlerList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |