Package com.github.stefvanschie.inventoryframework.gui.type

Class AnvilGui

java.lang.Object
com.github.stefvanschie.inventoryframework.gui.type.util.Gui
com.github.stefvanschie.inventoryframework.gui.type.util.NamedGui
com.github.stefvanschie.inventoryframework.gui.type.AnvilGui
All Implemented Interfaces:
InventoryBased, org.bukkit.inventory.InventoryHolder
public class AnvilGui extends NamedGui implements InventoryBased
Represents a gui in the form of an anvil
Since:
0.8.0

  • Constructor Details

    • AnvilGui

      public AnvilGui​(@NotNull @NotNull String title)
      Constructs a new anvil gui
      Parameters:
      title - the title/name of this gui.
      Since:
      0.8.0

    • AnvilGui

      public AnvilGui​(@NotNull @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)
      Constructs a new anvil gui
      Parameters:
      title - the title/name of this gui.
      Since:
      0.10.0

  • Method Details

    • show

      public void show​(@NotNull @NotNull org.bukkit.entity.HumanEntity humanEntity)
      Description copied from class: Gui
      Shows a gui to a player
      Specified by:
      show in class Gui
      Parameters:
      humanEntity - the human entity to show the gui to

    • copy

      @NotNull @Contract(pure=true) public @NotNull AnvilGui copy()
      Description copied from class: Gui
      Makes a copy of this gui and returns it. This makes a deep copy of the gui. This entails that the underlying panes will be copied as per their Pane.copy() and miscellaneous data will be copied. The copy of this gui, will however have no viewers even if this gui currently has viewers. With this, cache data for viewers will also be non-existent for the copied gui. The returned gui will never be reference equal to the current gui.
      Specified by:
      copy in class Gui
      Returns:
      a copy of the gui

    • click

      public void click​(@NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Description copied from class: Gui
      This should delegate the provided inventory click event to the right pane, which can then handle this click event further. This should not call any internal click handlers, since those will already have been activated.
      Specified by:
      click in class Gui
      Parameters:
      event - the event to delegate

    • getInventory

      @NotNull public @NotNull org.bukkit.inventory.Inventory getInventory()
      Specified by:
      getInventory in interface org.bukkit.inventory.InventoryHolder

    • createInventory

      @NotNull @Contract(pure=true) public @NotNull org.bukkit.inventory.Inventory createInventory()
      Description copied from interface: InventoryBased
      Creates a new inventory of the type of the implementing class.
      Specified by:
      createInventory in interface InventoryBased
      Returns:
      the new inventory

    • getRenameText

      @NotNull @Contract(pure=true) public @NotNull String getRenameText()
      Gets the rename text currently specified in the anvil.
      Returns:
      the rename text
      Since:
      0.8.0
      See Also:
      AnvilInventory.getRenameText()

    • isPlayerInventoryUsed

      @Contract(pure=true) public boolean isPlayerInventoryUsed()
      Description copied from class: Gui
      Gets whether the player inventory is currently in use. This means whether the player inventory currently has an item in it.
      Specified by:
      isPlayerInventoryUsed in class Gui
      Returns:
      true if the player inventory is occupied, false otherwise

    • getViewerCount

      @Contract(pure=true) public int getViewerCount()
      Description copied from class: Gui
      Gets the count of HumanEntity instances that are currently viewing this GUI.
      Specified by:
      getViewerCount in class Gui
      Returns:
      the count of viewers

    • getViewers

      @NotNull @Contract(pure=true) public @NotNull List<org.bukkit.entity.HumanEntity> getViewers()
      Description copied from class: Gui
      Gets a mutable snapshot of the current HumanEntity viewers of this GUI. This is a snapshot (copy) and not a view, therefore modifications aren't visible.
      Specified by:
      getViewers in class Gui
      Returns:
      a snapshot of the current viewers
      See Also:
      Gui.getViewerCount()

    • handleClickEvent

      public void handleClickEvent​(@NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Handles an incoming inventory click event
      Parameters:
      event - the event to handle
      Since:
      0.8.0

    • handleClose

      public void handleClose​(@NotNull @NotNull org.bukkit.entity.HumanEntity humanEntity)
      Handles a human entity closing this gui.
      Parameters:
      humanEntity - the human entity closing the gui
      Since:
      0.10.1

    • getFirstItemComponent

      @NotNull @Contract(pure=true) public @NotNull InventoryComponent getFirstItemComponent()
      Gets the inventory component representing the first item
      Returns:
      the first item component
      Since:
      0.8.0

    • getSecondItemComponent

      @NotNull @Contract(pure=true) public @NotNull InventoryComponent getSecondItemComponent()
      Gets the inventory component representing the second item
      Returns:
      the second item component
      Since:
      0.8.0

    • getResultComponent

      @NotNull @Contract(pure=true) public @NotNull InventoryComponent getResultComponent()
      Gets the inventory component representing the result
      Returns:
      the result component
      Since:
      0.8.0

    • getPlayerInventoryComponent

      @NotNull @Contract(pure=true) public @NotNull InventoryComponent getPlayerInventoryComponent()
      Gets the inventory component representing the player inventory
      Returns:
      the player inventory component
      Since:
      0.8.0

    • load

      @Nullable @Contract(pure=true) public static @Nullable AnvilGui load​(@NotNull @NotNull Object instance, @NotNull @NotNull InputStream inputStream)
      Loads an anvil gui from an XML file.
      Parameters:
      instance - the instance on which to reference fields and methods
      inputStream - the input stream containing the XML data
      Returns:
      the loaded anvil gui
      Since:
      0.8.0

    • load

      @NotNull public static @NotNull AnvilGui load​(@NotNull @NotNull Object instance, @NotNull @NotNull Element element)
      Loads an anvil gui from the specified element, applying code references to the provided instance.
      Parameters:
      instance - the instance on which to reference fields and methods
      element - the element to load the gui from
      Returns:
      the loaded anvil gui
      Since:
      0.8.0