Package me.hsgamer.hscore.minecraft.gui.holder

Class GUIHolder<T extends InventoryContext>

java.lang.Object
me.hsgamer.hscore.minecraft.gui.holder.GUIHolder<T>
Type Parameters:
T - the type of the inventory context
All Implemented Interfaces:
GUIElement
Direct Known Subclasses:
BukkitGUIHolder, MinestomGUIHolder
public abstract class GUIHolder<T extends InventoryContext> extends Object implements GUIElement
The base holder for Minecraft GUI implementation

  • Constructor Details

    • GUIHolder

      public GUIHolder(UUID viewerID)
      Create a new holder
      Parameters:
      viewerID - the unique ID of the viewer

  • Method Details

    • createInventoryContext

      protected abstract T createInventoryContext()
      Create the inventory context
      Returns:
      the inventory context

    • setItem

      protected abstract void setItem(int slot, @Nullable @Nullable ActionItem item)
      Set the item in the slot
      Parameters:
      slot - the slot
      item - the item

    • canSetItem

      protected boolean canSetItem(int slot)
      Check if the item can be set in the slot
      Parameters:
      slot - the slot
      Returns:
      true if the item can be set

    • open

      public abstract void open(UUID viewerID)
      Open the inventory
      Parameters:
      viewerID - the unique ID of the player

    • handleOpen

      public void handleOpen(OpenEvent event)
      Handle the open event. Override this method to add custom behavior.
      Parameters:
      event - the event

    • handleClose

      public void handleClose(CloseEvent event)
      Handle the close event. Override this method to add custom behavior.
      Parameters:
      event - the event

    • handleClick

      public void handleClick(ClickEvent event)
      Override this method to add custom behavior.

    • update

      public void update()
      Update the inventory

    • init

      public void init()
      Description copied from interface: GUIElement
      Initialize the element. Should be called before adding to the GUI.
      Specified by:
      init in interface GUIElement

    • stop

      public void stop()
      Description copied from interface: GUIElement
      Stop the element. Should be called after removing from the GUI.
      Specified by:
      stop in interface GUIElement

    • getViewerID

      public UUID getViewerID()
      Get the unique ID of the viewer
      Returns:
      the unique ID of the viewer

    • getInventoryContext

      public T getInventoryContext()
      Get the inventory context
      Returns:
      the inventory context

    • getItem

      public Optional<ActionItem> getItem(int slot)
      Get the item in the slot
      Parameters:
      slot - the slot
      Returns:
      the item

    • getItemMap

      public Map<Integer,ActionItem> getItemMap()
      Get the item map
      Returns:
      the item map

    • getButtonMap

      public Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> getButtonMap()
      Get the button map
      Returns:
      the button map

    • setButtonMap

      public void setButtonMap(Function<@NotNull InventoryContext,@Nullable Map<Integer,ActionItem>> buttonMap)
      Set the button map
      Parameters:
      buttonMap - the button map

    • open

      public void open()
      Open the inventory