Package com.kamikazejam.kamicommon.menu

Interface Menu<M extends Menu<M>>

All Known Implementing Classes:
AbstractMenu, OneClickMenu, PaginatedMenu, SimpleMenu
public interface Menu<M extends Menu<M>>
Represents the abstraction of a menu into the core parts that MenuManager needs to interact with.
This interface is not meant for public consumption or use, you will find none of the helpful methods you would expect.

Use specific menus classes like SimpleMenu or PaginatedMenu

  • Method Details

    • getEvents

      @NotNull @NotNull MenuEvents<M> getEvents()

    • getOptions

      @NotNull @NotNull MenuOptions<M> getOptions()

    • getMenuSize

      @NotNull @NotNull MenuSize getMenuSize()

    • getMenuIcons

      @NotNull @NotNull Map<String,MenuIcon<M>> getMenuIcons()

    • getMenuIconsAccess

      @NotNull @NotNull IMenuIconsAccess<M> getMenuIconsAccess()

    • getFillerIcon

      @Nullable @Nullable MenuIcon<M> getFillerIcon()

    • reopenMenu

      void reopenMenu()
      Attempt to reopen the menu for the given player. Depending on the menu type, this may not be possible for all possible
      By default, this method will NOT reset the tick counter.
      See reopenMenu(boolean) for reopening with reset.

    • reopenMenu

      void reopenMenu(boolean resetTickCounter)
      Attempt to reopen the menu for the given player. Depending on the menu type, this may not be possible for all possible
      Parameters:
      resetTickCounter - If true, the tick counter will be reset to 0. This is useful for menus that are not paginated, and

    • buildClickData

      @Internal @NotNull default @NotNull MenuClickData<M> buildClickData(@NotNull M menu, @NotNull @NotNull Player player, @NotNull @NotNull ClickType clickType, @NotNull @NotNull InventoryClickEvent event, int page, @NotNull @NotNull MenuIcon<M> icon, int iconSlot)

    • buildPlayerClickData

      @Internal @NotNull default @NotNull PlayerClickData<M> buildPlayerClickData(@NotNull M menu, @NotNull @NotNull Player player, @NotNull @NotNull ClickType clickType, @NotNull @NotNull InventoryClickEvent event, int slot)