Package net.swofty.gui.inventory

Class SkyBlockInventoryGUI

java.lang.Object
net.swofty.gui.inventory.SkyBlockInventoryGUI
Direct Known Subclasses:
GUIBanker, GUICrafting, GUIEnchantmentTable, GUIReforge, GUISkyBlockMenu, SkyBlockPaginatedGUI
public abstract class SkyBlockInventoryGUI extends Object

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    SkyBlockInventoryGUI.CloseReason
     
    static final record 
    SkyBlockInventoryGUI.InventoryGUIOpenEvent
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Map<UUID,SkyBlockInventoryGUI>
    GUI_MAP
     
    protected List<GUIItem>
    items
     
    protected net.minestom.server.inventory.InventoryType
    size
     
    protected String
    title
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SkyBlockInventoryGUI(String title, net.minestom.server.inventory.InventoryType size)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterOpen(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
    Runs after the GUI opens to the player
    abstract boolean
    allowHotkeying()
    Method to allow people to hotkey items into the GUI or not
    void
    border(net.minestom.server.item.ItemStack.Builder stack)
    Fills the border between two corners of your GUI with the item stack of your choice
    void
    border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2)
    Fills the border in a rectangle between two slots\ Overwrite is set to true by default in this method Pickup is set to false by default in this method
    void
    border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean pickup)
    Fills the border in a rectangle between two slots\ Overwrite is set to true by default in this method
    void
    border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean overwrite, boolean pickup)
    Fills the border of a rectangle between two slots
    void
    fill(net.minestom.server.item.ItemStack.Builder stack)
    Fills the whole inventory with the item stack of your choice
    void
    fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2)
    Fill a rectangle between two corners of the GUI Overwrite is set to true by default in this method Pickup is set to false by default in this method
    void
    fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean pickup)
    Fill a rectangle between two corners of the GUI Overwrite is set to true by default in this method
    void
    fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean overwrite, boolean pickup)
    Fill a rectangle between two corners of the GUI
    void
    fill(net.minestom.server.item.Material material, String name)
    Fills the whole inventory with the Material of your choice
    int
    firstEmpty()
    Iterates through all the slots and finds the first empty one
    GUIItem
    get(int slot)
    Get a GUI item that is in a slot
    abstract void
    onBottomClick(net.minestom.server.event.inventory.InventoryPreClickEvent e)
    Runs when the player clicks on their own inventory whole this GUI is open
    abstract void
    onClose(net.minestom.server.event.inventory.InventoryCloseEvent e, SkyBlockInventoryGUI.CloseReason reason)
    Runs when the player closes the gui
    void
    onOpen(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
    Runs when the player opens the gui
    void
    open(SkyBlockPlayer player)
    Opens the GUI for a player
    void
    set(int slot, net.minestom.server.item.ItemStack.Builder stack)
    Set an item inside the gui In this method pickup is set to false by default
    void
    set(int slot, net.minestom.server.item.ItemStack.Builder stack, boolean pickup)
    Set an item inside the gui
    void
    set(GUIItem a)
    Set an item inside the GUI
    void
    setItems(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
    Runs before the GUI opens, in order to set the items in
    abstract void
    suddenlyQuit(net.minestom.server.inventory.Inventory inventory, SkyBlockPlayer player)
     
    void
    updateItemStacks(net.minestom.server.inventory.Inventory inventory, SkyBlockPlayer player)
    re-set all the GUIItems inside of the inventory

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • SkyBlockInventoryGUI

      public SkyBlockInventoryGUI(String title, net.minestom.server.inventory.InventoryType size)

  • Method Details

    • set

      public void set(GUIItem a)
      Set an item inside the GUI
      Parameters:
      a - the item you want to set

    • set

      public void set(int slot, net.minestom.server.item.ItemStack.Builder stack, boolean pickup)
      Set an item inside the gui
      Parameters:
      slot - the slot the item should be in (any number between 0-53 depending on your GUI size)
      stack - the ItemStack that should be in the slot
      pickup - can the player pick up the item by clicking on it or no

    • set

      public void set(int slot, net.minestom.server.item.ItemStack.Builder stack)
      Set an item inside the gui In this method pickup is set to false by default
      Parameters:
      slot - the slot the item should be in (any number between 0-53 depending on your GUI size)
      stack - the ItemStack that should be in the slot

    • get

      public GUIItem get(int slot)
      Get a GUI item that is in a slot
      Parameters:
      slot - which slot the GUI item is in
      Returns:
      the GUIItem in that slot, if there is none, null

    • fill

      public void fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean overwrite, boolean pickup)
      Fill a rectangle between two corners of the GUI
      Parameters:
      stack - what ItemStack are we filling our rectangle with
      cornerSlot - the top left corner of our rectangle
      cornerSlot2 - the bottom right corner of our rectangle
      overwrite - if this is set to true, the method will ignore any items in the rectangle and replace them with 'stack'
      pickup - is the player able to pick up the items in the rectangle?

    • fill

      public void fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean pickup)
      Fill a rectangle between two corners of the GUI Overwrite is set to true by default in this method
      Parameters:
      stack - what ItemStack are we filling our rectangle with
      cornerSlot - the top left corner of our rectangle
      cornerSlot2 - the bottom right corner of our rectangle
      pickup - is the player able to pick up the items in the rectangle?

    • fill

      public void fill(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2)
      Fill a rectangle between two corners of the GUI Overwrite is set to true by default in this method Pickup is set to false by default in this method
      Parameters:
      stack - what ItemStack are we filling our rectangle with
      cornerSlot - the top left corner of our rectangle
      cornerSlot2 - the bottom right corner of our rectangle

    • fill

      public void fill(net.minestom.server.item.ItemStack.Builder stack)
      Fills the whole inventory with the item stack of your choice
      Parameters:
      stack - the ItemStack of your choice

    • fill

      public void fill(net.minestom.server.item.Material material, String name)
      Fills the whole inventory with the Material of your choice
      Parameters:
      material - the Material of your choice

    • border

      public void border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean overwrite, boolean pickup)
      Fills the border of a rectangle between two slots
      Parameters:
      stack - the ItemStack of your choice
      cornerSlot - the top left corner of your rectangle
      cornerSlot2 - the bottom right corner of your rectangle
      overwrite - if this is set to true, the method will ignore any items in between the lines and replace them
      pickup - if this is set to true, players will be able to pick up the items in your border

    • border

      public void border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2, boolean pickup)
      Fills the border in a rectangle between two slots\ Overwrite is set to true by default in this method
      Parameters:
      stack - the ItemStack of your choice
      cornerSlot - the top left corner of your rectangle
      cornerSlot2 - the bottom right corner of your rectangle
      pickup - if this is set to true, players will be able to pick up the items in your border

    • border

      public void border(net.minestom.server.item.ItemStack.Builder stack, int cornerSlot, int cornerSlot2)
      Fills the border in a rectangle between two slots\ Overwrite is set to true by default in this method Pickup is set to false by default in this method
      Parameters:
      stack - the ItemStack of your choice
      cornerSlot - the top left corner of your rectangle
      cornerSlot2 - the bottom right corner of your rectangle

    • border

      public void border(net.minestom.server.item.ItemStack.Builder stack)
      Fills the border between two corners of your GUI with the item stack of your choice
      Parameters:
      stack - the ItemStack of your choice

    • firstEmpty

      public int firstEmpty()
      Iterates through all the slots and finds the first empty one
      Returns:
      an empty slot index

    • open

      public void open(SkyBlockPlayer player)
      Opens the GUI for a player
      Parameters:
      player - the player the gui is being opened for

    • allowHotkeying

      public abstract boolean allowHotkeying()
      Method to allow people to hotkey items into the GUI or not
      Returns:
      a boolean

    • onOpen

      public void onOpen(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
      Runs when the player opens the gui
      Parameters:
      e - the event of the gui opening

    • onClose

      public abstract void onClose(net.minestom.server.event.inventory.InventoryCloseEvent e, SkyBlockInventoryGUI.CloseReason reason)
      Runs when the player closes the gui
      Parameters:
      e - the event of the gui closing

    • suddenlyQuit

      public abstract void suddenlyQuit(net.minestom.server.inventory.Inventory inventory, SkyBlockPlayer player)

    • onBottomClick

      public abstract void onBottomClick(net.minestom.server.event.inventory.InventoryPreClickEvent e)
      Runs when the player clicks on their own inventory whole this GUI is open
      Parameters:
      e - the event of the click

    • afterOpen

      public void afterOpen(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
      Runs after the GUI opens to the player
      Parameters:
      e - the event of the gui opening

    • setItems

      public void setItems(SkyBlockInventoryGUI.InventoryGUIOpenEvent e)
      Runs before the GUI opens, in order to set the items in
      Parameters:
      e - the event of the GUI opening

    • updateItemStacks

      public void updateItemStacks(net.minestom.server.inventory.Inventory inventory, SkyBlockPlayer player)
      re-set all the GUIItems inside of the inventory
      Parameters:
      inventory - an inventory object to set the items in