Interface MenuHandler<C>

All Known Subinterfaces:
InteractiveMenu<C>

public interface MenuHandler<C>
Optional event hooks for a Menu.

Implement this when a menu needs to react to open, close, click, or drag events.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    onClose(@NotNull MenuView<C,?> view, @NotNull org.bukkit.event.inventory.InventoryCloseEvent event)
    Runs when the menu is closed.
    default void
    onDrag(@NotNull MenuView<C,?> view, @NotNull org.bukkit.event.inventory.InventoryDragEvent event)
    Runs when the menu receives a drag event.
    default void
    onOpen(@NotNull MenuView<C,?> view, @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)
    Runs when the menu is opened.
    default void
    onPostClick(@NotNull MenuView<C,?> view, @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
    Runs after button dispatch.
    default boolean
    onPreClick(@NotNull MenuView<C,?> view, @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
    Runs before button dispatch.
  • Method Details

    • onPreClick

      default boolean onPreClick(@NotNull @NotNull MenuView<C,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Runs before button dispatch.
      Returns:
      true to continue handling the click
    • onPostClick

      default void onPostClick(@NotNull @NotNull MenuView<C,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Runs after button dispatch.
    • onOpen

      default void onOpen(@NotNull @NotNull MenuView<C,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)
      Runs when the menu is opened.
    • onClose

      default void onClose(@NotNull @NotNull MenuView<C,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryCloseEvent event)
      Runs when the menu is closed.
    • onDrag

      default void onDrag(@NotNull @NotNull MenuView<C,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryDragEvent event)
      Runs when the menu receives a drag event.