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

Class MerchantGui

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.MerchantGui
public class MerchantGui extends NamedGui
Represents a gui in the form of a merchant.
Since:
0.10.0

  • Constructor Details

    • MerchantGui

      public MerchantGui​(@NotNull @NotNull String title)
      Creates a merchant gui with the given title.
      Parameters:
      title - the title
      Since:
      0.10.0

    • MerchantGui

      public MerchantGui​(@NotNull @NotNull com.github.stefvanschie.inventoryframework.adventuresupport.TextHolder title)
      Creates a merchant gui with the given title.
      Parameters:
      title - the title
      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 public @NotNull Gui 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

    • addTrade

      public void addTrade​(@NotNull @NotNull org.bukkit.inventory.MerchantRecipe recipe, int discount)
      Adds a trade to this gui. The specified discount is the difference between the old price and the new price. For example, if a price was decreased from five to two, the discount would be three.
      Parameters:
      recipe - the recipe to add
      discount - the discount
      Since:
      0.10.1

    • setExperience

      public void setExperience​(int experience)
      Sets the experience of this merchant gui. Setting the experience will make the experience bar visible, even if the amount of experience is zero. Note that if the level of this merchant gui has not been set via setLevel(int) that the experience will always show as zero even when set to something else. Experience must be greater than or equal to zero. Attempting to set the experience to below zero will throw an IllegalArgumentException.
      Parameters:
      experience - the experience to set
      Throws:
      IllegalArgumentException - when the experience is below zero
      Since:
      0.10.1

    • setLevel

      public void setLevel​(int level)
      Sets the level of this merchant gui. This is a value between one and five and will visibly change the gui by appending the level of the villager to the title. These are displayed as "Novice", "Apprentice", "Journeyman", "Expert" and "Master" respectively (when the player's locale is set to English). When an argument is supplied that is not within one and five, an IllegalArgumentException will be thrown.
      Parameters:
      level - the numeric level
      Throws:
      IllegalArgumentException - when the level is not between one and five
      Since:
      0.10.1

    • addTrade

      public void addTrade​(@NotNull @NotNull org.bukkit.inventory.MerchantRecipe recipe)
      Adds a trade to this gui. This will not set a discount on the trade. For specifiying discounts, see addTrade(MerchantRecipe, int).
      Parameters:
      recipe - the recipe to add
      Since:
      0.10.0

    • handleClose

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

    • isPlayerInventoryUsed

      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()

    • getInputComponent

      @NotNull @Contract(pure=true) public @NotNull InventoryComponent getInputComponent()
      Gets the inventory component representing the input
      Returns:
      the input component
      Since:
      0.10.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.10.0

    • load

      @Nullable @Contract(pure=true) public static @Nullable MerchantGui load​(@NotNull @NotNull Object instance, @NotNull @NotNull InputStream inputStream)
      Loads a merchant 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 merchant gui
      Since:
      0.10.0

    • load

      @NotNull @Contract(pure=true) public static @NotNull MerchantGui load​(@NotNull @NotNull Object instance, @NotNull @NotNull Element element)
      Loads a merchant 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 merchant gui
      Since:
      0.10.0