Class InventoryDragEvent
- All Implemented Interfaces:
Cancellable
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
-
Method Summary
Modifier and TypeMethodDescriptionGets the result cursor after the drag is done.static @NotNull HandlerList
Gets the slots to be changed in this drag.Gets all items to be added to the inventory in this drag.Gets an ItemStack representing the cursor prior to any modifications as a result of this drag.Gets the raw slot ids to be changed in this drag.getType()
Gets the DragType that describes the behavior of ItemStacks placed after this InventoryDragEvent.void
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
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
InventoryDragEvent
-
-
Method Details
-
getNewItems
Gets all items to be added to the inventory in this drag.- Returns:
- map from raw slot id to new ItemStack
-
getRawSlots
Gets the raw slot ids to be changed in this drag.- Returns:
- list of raw slot ids, suitable for getView().getItem(int)
-
getInventorySlots
Gets the slots to be changed in this drag.- Returns:
- list of converted slot ids, suitable for
Inventory.getItem(int)
.
-
getCursor
Gets the result cursor after the drag is done. The returned value is mutable.- Returns:
- the result cursor
-
setCursor
Sets the result cursor after the drag is done.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.
- Parameters:
newCursor
- the new cursor ItemStack
-
getOldCursor
Gets an ItemStack representing the cursor prior to any modifications as a result of this drag.- Returns:
- the original cursor
-
getType
Gets the DragType that describes the behavior of ItemStacks placed after this InventoryDragEvent.The ItemStacks and the raw slots that they're being applied to can be found using
getNewItems()
.- Returns:
- the DragType of this InventoryDragEvent
-
getHandlers
- Overrides:
getHandlers
in classInventoryEvent
-
getHandlerList
-