Interface InventoryClickHandler

All Known Implementing Classes:
AbstractInventory, AnvilInventory, BeaconInventory, BrewingStandInventory, EnchantmentTableInventory, FurnaceInventory, Inventory, PlayerInventory, VillagerInventory
public sealed interface InventoryClickHandler permits AbstractInventory
Represents an inventory which can receive click input. All methods returning boolean returns true if the action is successful, false otherwise.

See the Minecraft wiki for more information.

  • Method Details

    • handleClick

      default boolean handleClick(@NotNull @NotNull Player player, @NotNull @NotNull Click click)
      Parses a click. This delegates to each individual implementation method.
      Parameters:
      player - the player who clicked
      click - the click that occurred
      Returns:
      whether or not the click was a success

    • leftClick

      boolean leftClick(@NotNull @NotNull Player player, int slot)
      Called when a Player left click in the inventory. Can also be to drop the cursor item
      Parameters:
      player - the player who clicked
      slot - the slot number
      Returns:
      true if the click hasn't been cancelled, false otherwise

    • rightClick

      boolean rightClick(@NotNull @NotNull Player player, int slot)
      Called when a Player right click in the inventory. Can also be to drop the cursor item
      Parameters:
      player - the player who clicked
      slot - the slot number
      Returns:
      true if the click hasn't been cancelled, false otherwise

    • shiftClick

      boolean shiftClick(@NotNull @NotNull Player player, int slot, int button)
      Called when a Player shift click in the inventory
      Parameters:
      player - the player who clicked
      slot - the slot number
      button - the button (same behaviour in vanilla, but can be used for custom behaviour)
      Returns:
      true if the click hasn't been cancelled, false otherwise

    • changeHeld

      boolean changeHeld(@NotNull @NotNull Player player, int slot, int key)
      Called when a Player held click in the inventory
      Parameters:
      player - the player who clicked
      slot - the slot number
      key - the held slot (0-8) pressed
      Returns:
      true if the click hasn't been cancelled, false otherwise

    • middleClick

      boolean middleClick(@NotNull @NotNull Player player, int slot)

    • drop

      boolean drop(@NotNull @NotNull Player player, boolean all, int slot)
      Called when a Player press the drop button
      Parameters:
      player - the player who clicked
      all -
      slot - the slot number (-999 if clicking outside, i.e. dropping cursor)
      Returns:
      true if the drop hasn't been cancelled, false otherwise

    • dragging

      boolean dragging(@NotNull @NotNull Player player, List<Integer> slots, int button)

    • doubleClick

      boolean doubleClick(@NotNull @NotNull Player player, int slot)
      Called when a Player double click in the inventory
      Parameters:
      player - the player who clicked
      slot - the slot number
      Returns:
      true if the click hasn't been cancelled, false otherwise

    • callClickEvent

      default void callClickEvent(@NotNull @NotNull Player player, @NotNull @NotNull AbstractInventory inventory, int slot, @NotNull @NotNull ClickType clickType, @NotNull @NotNull ItemStack clicked, @NotNull @NotNull ItemStack cursor)