Package dev.triumphteam.gui.builder.item

Class PaperItemBuilder

java.lang.Object
dev.triumphteam.gui.builder.item.BaseItemBuilder<PaperItemBuilder>
dev.triumphteam.gui.builder.item.PaperItemBuilder
public class PaperItemBuilder extends dev.triumphteam.gui.builder.item.BaseItemBuilder<PaperItemBuilder>
Main ItemBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull dev.triumphteam.gui.builder.item.BannerBuilder
    banner()
    Method for creating a BannerBuilder which will have BANNER specific methods
    static @NotNull dev.triumphteam.gui.builder.item.BannerBuilder
    banner(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a BannerBuilder which will have BANNER specific methods
    static @NotNull dev.triumphteam.gui.builder.item.BookBuilder
    book(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a BookBuilder which will have Material.WRITABLE_BOOK / Material.WRITTEN_BOOK specific methods
    static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder
    firework()
    Method for creating a FireworkBuilder which will have Material.FIREWORK_ROCKET specific methods
    static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder
    firework(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a FireworkBuilder which will have Material.FIREWORK_ROCKET specific methods
    static @NotNull PaperItemBuilder
    from(@NotNull org.bukkit.Material material)
    Alternative method to create PaperItemBuilder
    static @NotNull PaperItemBuilder
    from(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Main method to create PaperItemBuilder
    static @NotNull dev.triumphteam.gui.builder.item.MapBuilder
    map()
    Method for creating a MapBuilder which will have Material.MAP specific methods
    static @NotNull dev.triumphteam.gui.builder.item.MapBuilder
    map(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a MapBuilder which will have @link Material#MAP} specific methods
    static @NotNull dev.triumphteam.gui.builder.item.SkullBuilder
    skull()
    Method for creating a SkullBuilder which will have PLAYER_HEAD specific methods
    static @NotNull dev.triumphteam.gui.builder.item.SkullBuilder
    skull(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a SkullBuilder which will have PLAYER_HEAD specific methods
    static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder
    star()
    Method for creating a FireworkBuilder which will have Material.FIREWORK_STAR specific methods
    static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder
    star(@NotNull org.bukkit.inventory.ItemStack itemStack)
    Method for creating a FireworkBuilder which will have Material.FIREWORK_STAR specific methods

    Methods inherited from class dev.triumphteam.gui.builder.item.BaseItemBuilder

    addEnchantment, addEnchantment, addEnchantment, addItemFlags, addLore, addLore, amount, asGuiItem, asGuiItem, build, color, disenchant, enchant, enchant, enchant, enchant, enchant, flags, getItemStack, getMeta, glow, glow, lore, lore, lore, model, name, pdc, removeEnchantment, removeNbt, setAmount, setItemStack, setLore, setLore, setMeta, setName, setNbt, setNbt, setUnbreakable, unbreakable, unbreakable

    Methods inherited from class java.lang.Object

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

  • Method Details

    • from

      @NotNull @Contract("_ -> new") public static @NotNull PaperItemBuilder from(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Main method to create PaperItemBuilder
      Parameters:
      itemStack - The ItemStack you want to edit
      Returns:
      A new PaperItemBuilder

    • from

      @NotNull @Contract("_ -> new") public static @NotNull PaperItemBuilder from(@NotNull @NotNull org.bukkit.Material material)
      Alternative method to create PaperItemBuilder
      Parameters:
      material - The Material you want to create an item from
      Returns:
      A new PaperItemBuilder

    • banner

      @NotNull @Contract(" -> new") public static @NotNull dev.triumphteam.gui.builder.item.BannerBuilder banner()
      Method for creating a BannerBuilder which will have BANNER specific methods
      Returns:
      A new BannerBuilder
      Since:
      3.0.1

    • banner

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.BannerBuilder banner(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a BannerBuilder which will have BANNER specific methods
      Parameters:
      itemStack - An existing BANNER ItemStack
      Returns:
      A new BannerBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item is not a BANNER
      Since:
      3.0.1

    • book

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.BookBuilder book(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a BookBuilder which will have Material.WRITABLE_BOOK / Material.WRITTEN_BOOK specific methods
      Parameters:
      itemStack - an existing Material.WRITABLE_BOOK / Material.WRITTEN_BOOK ItemStack
      Returns:
      A new FireworkBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item type is not Material.WRITABLE_BOOK or Material.WRITTEN_BOOK
      Since:
      3.0.1

    • firework

      @NotNull @Contract(" -> new") public static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder firework()
      Method for creating a FireworkBuilder which will have Material.FIREWORK_ROCKET specific methods
      Returns:
      A new FireworkBuilder
      Since:
      3.0.1

    • firework

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder firework(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a FireworkBuilder which will have Material.FIREWORK_ROCKET specific methods
      Parameters:
      itemStack - an existing Material.FIREWORK_ROCKET ItemStack
      Returns:
      A new FireworkBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item type is not Material.FIREWORK_ROCKET
      Since:
      3.0.1

    • map

      @NotNull @Contract(" -> new") public static @NotNull dev.triumphteam.gui.builder.item.MapBuilder map()
      Method for creating a MapBuilder which will have Material.MAP specific methods
      Returns:
      A new MapBuilder
      Since:
      3.0.1

    • map

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.MapBuilder map(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a MapBuilder which will have @link Material#MAP} specific methods
      Parameters:
      itemStack - An existing Material.MAP ItemStack
      Returns:
      A new MapBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item type is not Material.MAP
      Since:
      3.0.1

    • skull

      @NotNull @Contract(" -> new") public static @NotNull dev.triumphteam.gui.builder.item.SkullBuilder skull()
      Method for creating a SkullBuilder which will have PLAYER_HEAD specific methods
      Returns:
      A new SkullBuilder

    • skull

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.SkullBuilder skull(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a SkullBuilder which will have PLAYER_HEAD specific methods
      Parameters:
      itemStack - An existing PLAYER_HEAD ItemStack
      Returns:
      A new SkullBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item is not a player head

    • star

      @NotNull @Contract(" -> new") public static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder star()
      Method for creating a FireworkBuilder which will have Material.FIREWORK_STAR specific methods
      Returns:
      A new FireworkBuilder
      Since:
      3.0.1

    • star

      @NotNull @Contract("_ -> new") public static @NotNull dev.triumphteam.gui.builder.item.FireworkBuilder star(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack)
      Method for creating a FireworkBuilder which will have Material.FIREWORK_STAR specific methods
      Parameters:
      itemStack - an existing Material.FIREWORK_STAR ItemStack
      Returns:
      A new FireworkBuilder
      Throws:
      dev.triumphteam.gui.components.exception.GuiException - if the item type is not Material.FIREWORK_STAR
      Since:
      3.0.1