Interface HytaleMenuAPI<P>

Type Parameters:
P - player type

public interface HytaleMenuAPI<P>
Experimental API for opening and managing Hytale custom UI menus.

This API is Hytale-specific and is backed by HyUI pages in the core. It is additive and optional: non-Hytale runtimes may return null from accessors that expose this API.

Since:
3.2
  • Method Details

    • registerMenu

      void registerMenu(String menuId, HytaleMenuDefinition definition)
      Register a reusable menu definition by id.
      Parameters:
      menuId - unique identifier (without extension)
      definition - menu definition
    • unregisterMenu

      void unregisterMenu(String menuId)
      Unregister a previously registered menu definition.
      Parameters:
      menuId - menu identifier
    • openMenu

      default boolean openMenu(P player, String menuId)
      Open a registered menu for the given player.
      Parameters:
      player - player to open for
      menuId - registered menu id
      Returns:
      true if opened
    • openMenu

      boolean openMenu(P player, String menuId, Map<String,String> placeholders)
      Open a registered menu for the given player.
      Parameters:
      player - player to open for
      menuId - registered menu id
      placeholders - placeholder map
      Returns:
      true if opened
    • openMenu

      default boolean openMenu(P player, HytaleMenuDefinition definition)
      Open an ad-hoc menu definition for the given player.
      Parameters:
      player - player to open for
      definition - menu definition
      Returns:
      true if opened
    • openMenu

      boolean openMenu(P player, HytaleMenuDefinition definition, Map<String,String> placeholders)
      Open an ad-hoc menu definition for the given player.
      Parameters:
      player - player to open for
      definition - menu definition
      placeholders - placeholder map
      Returns:
      true if opened
    • registerModuleActionHandler

      void registerModuleActionHandler(String moduleId, HytaleMenuActionHandler<P> handler)
      Register a module action handler for MODULE; menu actions.
      Parameters:
      moduleId - module id
      handler - action handler
    • unregisterModuleActionHandler

      void unregisterModuleActionHandler(String moduleId)
      Unregister a previously registered module action handler.
      Parameters:
      moduleId - module id