Package net.blueva.arcade.api.ui
Interface MenuAPI<P,M>
public interface MenuAPI<P,M>
API for opening custom menus in a platform-agnostic way.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanisBedrockPlayer(P player) Check if a player is a Bedrock player (Floodgate).default booleanopenDynamicMenu(P player, DynamicMenuDefinition<M> menu, List<MenuEntry<M>> entries, int page) Open a dynamic menu for a player.booleanopenDynamicMenu(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.default booleanopenMenu(P player, MenuDefinition<M> menu) Open a static menu for a player.booleanOpen a static menu for a player with placeholder replacements.booleanopenMenuById(P player, String menuId) Open a menu by ID.voidregisterModuleActionHandler(String moduleId, ModuleActionHandler<P> handler) Register a module action handler for menu actions.default voidregisterModuleMenuAPI(String moduleId, MenuAPI<P, M> handler) Register a module-scoped MenuAPI implementation.voidunregisterModuleActionHandler(String moduleId) Unregister a module action handler.default voidunregisterModuleMenuAPI(String moduleId) Unregister a previously registered module MenuAPI.
-
Method Details
-
isBedrockPlayer
Check if a player is a Bedrock player (Floodgate).- Parameters:
player- Player instance- Returns:
- true if the player is Bedrock
-
registerModuleActionHandler
Register a module action handler for menu actions.- Parameters:
moduleId- Module identifier (e.g., "skywars")handler- Handler to execute for MODULE actions
-
unregisterModuleActionHandler
Unregister a module action handler.- Parameters:
moduleId- Module identifier
-
openMenuById
Open a menu by ID. The menu must be registered with the core MenuManager.- Parameters:
player- Player to open the menu formenuId- Menu identifier (without .yml extension)- Returns:
- true if the menu was opened successfully
-
registerModuleMenuAPI
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
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