Interface MenuAPI<P,M>


public interface MenuAPI<P,M>
API for opening custom menus in a platform-agnostic way.
  • Method Details

    • openMenu

      default boolean openMenu(P player, MenuDefinition<M> menu)
      Open a static menu for a player.
      Parameters:
      player - Player that will receive the menu
      menu - Menu definition
      Returns:
      true if the menu was opened
    • openMenu

      boolean openMenu(P player, MenuDefinition<M> menu, Map<String,String> placeholders)
      Open a static menu for a player with placeholder replacements.
      Parameters:
      player - Player that will receive the menu
      menu - Menu definition
      placeholders - Placeholder values (e.g. "{player}")
      Returns:
      true if the menu was opened
    • openDynamicMenu

      default boolean openDynamicMenu(P player, DynamicMenuDefinition<M> menu, List<MenuEntry<M>> entries, int page)
      Open a dynamic menu for a player.
      Parameters:
      player - Player that will receive the menu
      menu - Dynamic menu definition
      entries - Entries to render
      page - Page index starting at 1
      Returns:
      true if the menu was opened
    • openDynamicMenu

      boolean openDynamicMenu(P player, DynamicMenuDefinition<M> menu, List<MenuEntry<M>> entries, int page, Map<String,String> placeholders)
      Open a dynamic menu for a player with placeholder replacements.
      Parameters:
      player - Player that will receive the menu
      menu - Dynamic menu definition
      entries - Entries to render
      page - Page index starting at 1
      placeholders - Placeholder values (e.g. "{player}")
      Returns:
      true if the menu was opened
    • isBedrockPlayer

      boolean isBedrockPlayer(P player)
      Check if a player is a Bedrock player (Floodgate).
      Parameters:
      player - Player instance
      Returns:
      true if the player is Bedrock
    • registerModuleActionHandler

      void registerModuleActionHandler(String moduleId, ModuleActionHandler<P> handler)
      Register a module action handler for menu actions.
      Parameters:
      moduleId - Module identifier (e.g., "skywars")
      handler - Handler to execute for MODULE actions
    • unregisterModuleActionHandler

      void unregisterModuleActionHandler(String moduleId)
      Unregister a module action handler.
      Parameters:
      moduleId - Module identifier
    • openMenuById

      boolean openMenuById(P player, String menuId)
      Open a menu by ID. The menu must be registered with the core MenuManager.
      Parameters:
      player - Player to open the menu for
      menuId - Menu identifier (without .yml extension)
      Returns:
      true if the menu was opened successfully
    • registerModuleMenuAPI

      default void registerModuleMenuAPI(String moduleId, MenuAPI<P,M> handler)
      Register a module-scoped MenuAPI implementation. The core will delegate openMenu() calls for the given module prefix to this handler. The default implementation is a no-op; override in core implementations.
      Parameters:
      moduleId - Module/game identifier (e.g. "skywars")
      handler - MenuAPI implementation that handles the module's own menus
      Since:
      3.3
    • unregisterModuleMenuAPI

      default void unregisterModuleMenuAPI(String moduleId)
      Unregister a previously registered module MenuAPI. The default implementation is a no-op; override in core implementations.
      Parameters:
      moduleId - Module/game identifier
      Since:
      3.3