Creating Ordinary Menus

Perquisites

Lotus depends on java 17 to operate. make sure you have those before we begin

Initializing Lotus API

You must create a Lotus instance in your onEnable() Quick example:

public class Test extends JavaPlugin {

   private Lotus api;
	
   @Override
   public void onEnable() {
     api = Lotus.load(this); //or you can use the other Lotus#load method to specify EventPriority for onClick event
   }

}

Creating and opening menus

In Lotus, menus object MenuView is not meant to be dealt with when using the API. You should stick to using a Menu; it's an interface that defines the information created when opening the menus.

Here's an example:

public final class ExampleMenu implements Menu {
	
	/**
	 * @return The unique name for this menu
	 */
	@Override
	public String getName() {
		return "example menu";
	}

	/**
	 * @param extraData the data container for this menu for extra data
	 * @param opener    the player who is opening this menu
	 * @return the title for this menu
	 */
	@Override
	public @NotNull MenuTitle getTitle(DataRegistry extraData, Player opener) {
		return MenuTitles.createLegacy("&cExample Menu");
	}

	/**
	 * @param extraData the data container for this menu for extra data
	 * @param opener    the player who is opening this menu
	 * @return the capacity/size for this menu
	 */
	@Override
	public @NotNull Capacity getCapacity(DataRegistry extraData, Player opener) {
		return Capacity.ofRows(3);//Alternative approach: Capacity.ofRows(3)
	}

	/**
	 * Creates the content for the menu
	 *
	 * @param extraData the data container for this menu for extra data
	 * @param opener    the player opening this menu
	 * @param capacity  the capacity set by the user above
	 * @return the content of the menu to add (this includes items)
	 */
	@Override
	public @NotNull Content getContent(DataRegistry extraData,
	                                   Player opener, Capacity capacity) {

		Button borderPane = Button.clickable(
				ItemBuilder.legacy(Material.STAINED_GLASS_PANE, 1, (short) 5).build(),
				ButtonClickAction.plain((menuView, event) -> {
					event.setCancelled(true);
					//we want nothing to happen here
					menuView.updateButton(event.getSlot(), (button)-> {
                        assert button.getItem() != null;
                        var item = button.getItem();
						item.setDurability((short)6);
						button.setItem(item);
					});
				})
		);

		return Content.builder(capacity)
				.iterate(Slot.of(10), Slot.of(16), Direction.RIGHT, ((content, slot) -> {
					content.setButton(slot, borderPane);
				}))
				.build();
	}
	
	@Override
	public void onClick(MenuView<?> playerMenuView, InventoryClickEvent event) {
		//happens after button click is executed
		event.setCancelled(true);
	}
}

Opening the menus

Call the method Lotus#openMenu example >>

api.openMenu(player, new ExampleMenu());

Result

More

If you want more detailed wiki check out other pages on the right-side of this page and thanks in advance <3