Package org.bukkit.event.inventory

Class InventoryDragEvent

  • All Implemented Interfaces:
    Cancellable
    public class InventoryDragEvent
extends InventoryInteractEvent
    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.

    To invoke one of these methods, schedule a task using 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.

    • Method Detail

      • getNewItems

        @NotNull
public @NotNull Map<Integer,​ItemStack> getNewItems()
        Gets all items to be added to the inventory in this drag.
        Returns:
        map from raw slot id to new ItemStack

      • getRawSlots

        @NotNull
public @NotNull Set<Integer> getRawSlots()
        Gets the raw slot ids to be changed in this drag.
        Returns:
        list of raw slot ids, suitable for getView().getItem(int)

      • getInventorySlots

        @NotNull
public @NotNull Set<Integer> getInventorySlots()
        Gets the slots to be changed in this drag.
        Returns:
        list of converted slot ids, suitable for Inventory.getItem(int).

      • getCursor

        @Nullable
public @Nullable ItemStack getCursor()
        Gets the result cursor after the drag is done. The returned value is mutable.
        Returns:
        the result cursor

      • setCursor

        public void setCursor​(@Nullable
                      @Nullable ItemStack newCursor)
        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

        @NotNull
public @NotNull ItemStack getOldCursor()
        Gets an ItemStack representing the cursor prior to any modifications as a result of this drag.
        Returns:
        the original cursor

      • getType

        @NotNull
public @NotNull DragType 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

      • getHandlerList

        @NotNull
public static @NotNull HandlerList getHandlerList()