dev.oumaimaa.kawaiiapi.menu.Menu

All Implemented Interfaces:: org.bukkit.inventory.InventoryHolder

Direct Known Subclasses:: PaginatedMenu

public abstract class Menu extends Object implements org.bukkit.inventory.InventoryHolder

Abstract base class for creating custom inventory menus using modern Paper API. Provides a comprehensive framework for menu creation with built-in utilities for item creation and inventory management.

Features:

Adventure Component support for all text
Automatic filler glass placement
Menu history and navigation
Customizable click handling
Close event handling

Version:: 1.0
Author:: KawaiiDevelopment

Field Summary

Fields

Modifier and Type

Field

Description

protected org.bukkit.inventory.ItemStack

FILLER_GLASS

protected org.bukkit.inventory.Inventory

inventory

protected final org.bukkit.entity.Player

player

protected final PlayerMenuUtility

playerMenuUtility
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Menu(@NotNull PlayerMenuUtility playerMenuUtility)

Constructs a new Menu instance.
Method Summary

Modifier and Type

Method

Description

void

back()

Navigates back to the previous menu in the history stack.

abstract boolean

cancelAllClicks()

Determines whether all inventory clicks should be cancelled by default.

@NotNull org.bukkit.inventory.Inventory

getInventory()

abstract @NotNull String

getMenuName()

Gets the name/title of this menu to be displayed in the inventory.

protected @NotNull org.bukkit.entity.Player

getPlayer()

Gets the player who owns this menu instance.

protected @NotNull PlayerMenuUtility

getPlayerMenuUtility()

Gets the PlayerMenuUtility associated with this menu.

abstract int

getSlots()

Gets the number of slots for this menu inventory.

abstract void

handleMenu(@NotNull org.bukkit.event.inventory.InventoryClickEvent e)

Handles click events within this menu.

void

handleMenuClose()

Called when a player closes this menu.

protected boolean

isOpen()

Checks if the menu is currently open.

protected @NotNull org.bukkit.inventory.ItemStack

makeItem(@NotNull org.bukkit.Material material, int amount, @NotNull String displayName, @NotNull String... lore)

Creates an ItemStack with a specific amount.

protected @NotNull org.bukkit.inventory.ItemStack

makeItem(@NotNull org.bukkit.Material material, @NotNull String displayName, @NotNull String... lore)

Creates an ItemStack with display name and lore using modern Components.

void

open()

Opens this menu for the player.

protected void

playSound(@NotNull org.bukkit.Sound sound, float volume, float pitch)

Plays a sound to the player viewing this menu.

protected void

reload()

Closes and reopens this menu, effectively performing a full refresh.

protected void

reloadItems()

Reloads the current menu by clearing and repopulating all items.

protected void

sendMessage(@NotNull String message)

Sends a message to the player viewing this menu.

void

setFillerGlass()

Fills all empty slots in the inventory with the default filler glass.

void

setFillerGlass(@NotNull org.bukkit.inventory.ItemStack itemStack)

Fills all empty slots with a custom filler item.

abstract void

setMenuItems()

Sets up all items in the menu inventory.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- playerMenuUtility
  
  protected final PlayerMenuUtility playerMenuUtility
- player
  
  protected final org.bukkit.entity.Player player
- inventory
  
  protected org.bukkit.inventory.Inventory inventory
- FILLER_GLASS
  
  protected org.bukkit.inventory.ItemStack FILLER_GLASS
Constructor Details
- Menu
  
  protected Menu(@NotNull @NotNull PlayerMenuUtility playerMenuUtility)
  
  Constructs a new Menu instance.
  
  Parameters:
  
  playerMenuUtility - The PlayerMenuUtility containing player-specific data
Method Details
- getMenuName
  
  @NotNull public abstract @NotNull String getMenuName()
  
  Gets the name/title of this menu to be displayed in the inventory. Supports legacy color codes (&) and hex colors (invalid input: '&#'RRGGBB).
  
  Returns:
  
  The menu name
- getSlots
  
  public abstract int getSlots()
  
  Gets the number of slots for this menu inventory. Must be a multiple of 9, between 9 and 54.
  
  Returns:
  
  The slot count
- cancelAllClicks
  
  public abstract boolean cancelAllClicks()
  
  Determines whether all inventory clicks should be cancelled by default. Return true for non-interactive menus, false for menus where players can take items.
  
  Returns:
  
  true to cancel all clicks, false to allow item interaction
- handleMenu
  
  public abstract void handleMenu(@NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent e) throws MenuManagerNotSetupException, MenuManagerException
  
  Handles click events within this menu. Override this method to implement custom click behavior.
  
  Parameters:
  
  e - The InventoryClickEvent to handle
  
  Throws:
  
  MenuManagerNotSetupException - If the MenuManager is not initialized
  
  MenuManagerException - If an error occurs during menu handling
- setMenuItems
  
  public abstract void setMenuItems()
  
  Sets up all items in the menu inventory. Called when the menu is opened or reloaded. Override this method to populate your menu with items.
- open
  
  public void open()
  
  Opens this menu for the player. Creates the inventory, populates items, and displays it to the player.
- back
  
  public void back() throws MenuManagerException, MenuManagerNotSetupException
  
  Navigates back to the previous menu in the history stack.
  
  Throws:
  
  MenuManagerException - If menu navigation fails
  
  MenuManagerNotSetupException - If the MenuManager is not initialized
- reloadItems
  
  protected void reloadItems()
  
  Reloads the current menu by clearing and repopulating all items. Maintains the menu open while refreshing content.
- reload
  
  protected void reload() throws MenuManagerException, MenuManagerNotSetupException
  
  Closes and reopens this menu, effectively performing a full refresh.
  
  Throws:
  
  MenuManagerException - If menu reload fails
  
  MenuManagerNotSetupException - If the MenuManager is not initialized
- getInventory
  
  @NotNull public @NotNull org.bukkit.inventory.Inventory getInventory()
  
  Specified by:
  
  getInventory in interface org.bukkit.inventory.InventoryHolder
- setFillerGlass
  
  public void setFillerGlass()
  
  Fills all empty slots in the inventory with the default filler glass.
- setFillerGlass
  
  public void setFillerGlass(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
  
  Fills all empty slots with a custom filler item.
  
  Parameters:
  
  itemStack - The item to use as filler
- makeItem
  
  @NotNull protected @NotNull org.bukkit.inventory.ItemStack makeItem(@NotNull @NotNull org.bukkit.Material material, @NotNull @NotNull String displayName, @NotNull @NotNull String... lore)
  
  Creates an ItemStack with display name and lore using modern Components. Automatically translates color codes using ColorTranslator.
  
  Parameters:
  
  material - The material type
  
  displayName - The display name (supports & and invalid input: '&#'RRGGBB)
  
  lore - The lore lines (supports & and invalid input: '&#'RRGGBB)
  
  Returns:
  
  The constructed ItemStack
- makeItem
  
  @NotNull protected @NotNull org.bukkit.inventory.ItemStack makeItem(@NotNull @NotNull org.bukkit.Material material, int amount, @NotNull @NotNull String displayName, @NotNull @NotNull String... lore)
  
  Creates an ItemStack with a specific amount.
  
  Parameters:
  
  material - The material type
  
  amount - The stack size (1-64, automatically clamped)
  
  displayName - The display name
  
  lore - The lore lines
  
  Returns:
  
  The constructed ItemStack
- handleMenuClose
  
  public void handleMenuClose()
  
  Called when a player closes this menu. Override this method to handle menu closing events (cleanup, saving data, etc.). Called before the inventory is actually closed.
- getPlayer
  
  @NotNull protected @NotNull org.bukkit.entity.Player getPlayer()
  
  Gets the player who owns this menu instance.
  
  Returns:
  
  The player instance
- getPlayerMenuUtility
  
  @NotNull protected @NotNull PlayerMenuUtility getPlayerMenuUtility()
  
  Gets the PlayerMenuUtility associated with this menu.
  
  Returns:
  
  The PlayerMenuUtility instance
- isOpen
  
  protected boolean isOpen()
  
  Checks if the menu is currently open.
  
  Returns:
  
  true if the player has this menu open
- sendMessage
  
  protected void sendMessage(@NotNull @NotNull String message)
  
  Sends a message to the player viewing this menu.
  
  Parameters:
  
  message - The message to send (supports color codes)
- playSound
  
  protected void playSound(@NotNull @NotNull org.bukkit.Sound sound, float volume, float pitch)
  
  Plays a sound to the player viewing this menu.
  
  Parameters:
  
  sound - The sound to play
  
  volume - The volume (0.0-1.0)
  
  pitch - The pitch (0.5-2.0)

Class Menu

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

playerMenuUtility

player

inventory

FILLER_GLASS

Constructor Details

Menu

Method Details

getMenuName

getSlots

cancelAllClicks

handleMenu

setMenuItems

open

back

reloadItems

reload

getInventory

setFillerGlass

setFillerGlass

makeItem

makeItem

handleMenuClose

getPlayer

getPlayerMenuUtility

isOpen

sendMessage

playSound