Package net.blueva.arcade.api.ui
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 Summary
Modifier and TypeMethodDescriptiondefault booleanOpen a registered menu for the given player.booleanOpen a registered menu for the given player.default booleanopenMenu(P player, HytaleMenuDefinition definition) Open an ad-hoc menu definition for the given player.booleanOpen an ad-hoc menu definition for the given player.voidregisterMenu(String menuId, HytaleMenuDefinition definition) Register a reusable menu definition by id.voidregisterModuleActionHandler(String moduleId, HytaleMenuActionHandler<P> handler) Register a module action handler forMODULE;menu actions.voidunregisterMenu(String menuId) Unregister a previously registered menu definition.voidunregisterModuleActionHandler(String moduleId) Unregister a previously registered module action handler.
-
Method Details
-
unregisterMenu
Unregister a previously registered menu definition.- Parameters:
menuId- menu identifier
-
openMenu
Open a registered menu for the given player.- Parameters:
player- player to open formenuId- registered menu id- Returns:
- true if opened
-
openMenu
Open a registered menu for the given player.- Parameters:
player- player to open formenuId- registered menu idplaceholders- placeholder map- Returns:
- true if opened
-
registerModuleActionHandler
Register a module action handler forMODULE;menu actions.- Parameters:
moduleId- module idhandler- action handler
-
unregisterModuleActionHandler
Unregister a previously registered module action handler.- Parameters:
moduleId- module id