An API for making menus inside Minecraft's chat. This API treats Minecraft's chat like a 2D grid, allowing you to position elements freely in chat.
Add ChatMenuAPI.jar to your build path, then add it as a dependency in your plugin.yml:
depend: [ChatMenuAPI]To create a menu, just create a new instance of me.tom.sparse.spigot.chat.menu.ChatMenu:
ChatMenu menu = new ChatMenu();If you are not using this API just for chat formatting, it is recommended that you make the menu a pausing menu:
ChatMenu menu = new ChatMenu().pauseChat();When this menu is sent to a player, it will automatically pause outgoing chat to that player so that the menu will not be interrupted.
Warning: If you make a menu pause chat, you need to add a way to close the menu!
Elements are the building blocks of menus. They are used to represent everything in a menu. There are a few elements provided by default, you can view them by clicking here.
Basic TextElement:
menu.add(new TextElement("Hello, world!", 10, 10));Basic close button:
menu.add(new ButtonElement(x, y, ChatColor.RED + "[Close]", player -> { menu.close(player); return false; }));Instead of manually creating a close button, you can also just pass the arguments you would use for a close button directly into the pauseChat method.
ChatMenu menu = new ChatMenu().pauseChat(x, y, ChatColor.RED + "[Close]");All of the default elements require and X and Y in their constructor, these coordinates should be greater than or equal to 0 and less than 320 on the X axis and 20 on the Y axis. The default Minecraft chat is 320 pixels wide and 20 lines tall.
Most interactive elements have one or more State objects.
States are used to store information about an Element, such as the current number in an IncrementalElement.
Every state can have a change callback to detect when it changes:
IncrementalElement incr = ...;
incr.value.setChangeCallback(state -> {
System.out.println("IncrementalElement changed! " + state.getPrevious() + " -> " + state.getCurrent());
});Once you've created your menu and added all the elements you want, now would probably be a good time to display it.
You can display a menu using ChatMenu#openFor(org.bukkit.entity.Player):
Player player = ...;
menu.openFor(player);