Interface InventoryMenu

All Superinterfaces:
org.bukkit.inventory.InventoryHolder
All Known Implementing Classes:
AbstractListMenu, AbstractMenu, ActionTypeSelectionMenu, BlocksCategorySelectionMenu, BlocksManipulatorMenu, BlocksWithMenusCategoryMenu, ConfirmationMenu, ContentWithMenusCategoryMenu, CreativeMenu, EnderChestMenu, EntitiesBrowserMenu, EventValuesCategorySelectionMenu, EventValueSelectionMenu, ExecutorArgumentsMenu, ExecutorTypeSelectionMenu, FunctionChooserMenu, Layout, LayoutMaker, ListBrowserMenu, MenusCategorySelectionMenu, MethodChooserMenu, ModulesBrowserMenu, ModuleSettingsMenu, OwnModulesBrowserMenu, OwnWorldsBrowserMenu, ParticlesMenu, PlayerControlMenu, PlayersBrowserMenu, PotionsMenu, RecommendedWorldsBrowserMenu, RepeatConditionSelectionMenu, SelectionActionsMenu, TargetSelectionMenu, ValueTargetSelectionMenu, VariablesMenu, WanderMenu, WanderSettingsMenu, WorldAccessMenu, WorldEnvironmentColorMenu, WorldEnvironmentMenu, WorldGenerationMenu, WorldModerationMenu, WorldsBrowserMenu, WorldsCompassMenu, WorldSettingsCategoryMenu, WorldSettingsFlagsMenu, WorldSettingsMenu, WorldsPickerMenu
public interface InventoryMenu extends org.bukkit.inventory.InventoryHolder

InventoryMenu

This interface represents an inventory menus, that can be opened for player. It has functions to listen click, open and close events.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    destroy()
    Destroys menus from memory and disables all event listeners for it.
    long
    getCreationTime()
    Returns the creation time of menu in milliseconds of Unix format.
    void
    onClick(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)
    Executes when player clicks in inventory.
    default void
    onClose(@NotNull org.bukkit.event.inventory.InventoryCloseEvent event)
    Executes when player closes inventory.
    void
    onOpen(@NotNull org.bukkit.event.inventory.InventoryOpenEvent event)
    Executes when player opens inventory and sees it first time.
    void
    open(@NotNull org.bukkit.entity.Player player)
    Opens the inventory for player.

    Methods inherited from interface org.bukkit.inventory.InventoryHolder

    getInventory

  • Method Details

    • open

      void open(@NotNull @NotNull org.bukkit.entity.Player player)
      Opens the inventory for player.
      Parameters:
      player - player to open menus.

    • onClick

      void onClick(@NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Executes when player clicks in inventory.
      Parameters:
      event - event of click in inventory.

    • onOpen

      void onOpen(@NotNull @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)
      Executes when player opens inventory and sees it first time. Useful for playing sounds or setting items.
      Parameters:
      event - event of inventory open.

    • onClose

      default void onClose(@NotNull @NotNull org.bukkit.event.inventory.InventoryCloseEvent event)
      Executes when player closes inventory.

      NOTE: Menu should be unregistered after closing it.

      Parameters:
      event - event of inventory close.
      See Also:

    • getCreationTime

      long getCreationTime()
      Returns the creation time of menu in milliseconds of Unix format.
      Returns:
      creation time of menu.

    • destroy

      default void destroy()
      Destroys menus from memory and disables all event listeners for it.