Package fr.multimc.api.spigot.common.tools.builders.items

Class ItemBuilder

java.lang.Object
fr.multimc.api.spigot.common.tools.builders.items.ItemBuilder
Direct Known Subclasses:
BookBuilder, LeatherArmorBuilder, SkullBuilder
public class ItemBuilder extends Object
Create easily an item.
Since:
04/10/2022

  • Constructor Details

    • ItemBuilder

      public ItemBuilder(@NotNull @NotNull org.bukkit.inventory.ItemStack item)
      Create an instance of an existing item.
      Parameters:
      item - Base item.

    • ItemBuilder

      public ItemBuilder(@NotNull @NotNull org.bukkit.Material material)
      Create a new item.
      Parameters:
      material - Item type.

    • ItemBuilder

      public ItemBuilder(@NotNull @NotNull org.bukkit.Material material, int amount)
      Create a new item with a different amount.
      Parameters:
      material - Item type.
      amount - Item amount.

  • Method Details

    • build

      public org.bukkit.inventory.ItemStack build()
      Build the modified item.
      Returns:
      Item modified.

    • getMeta

      public org.bukkit.inventory.meta.ItemMeta getMeta()
      Get the item metadata.
      Returns:
      Item metadata.

    • applyMeta

      public ItemBuilder applyMeta(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)
      Apply the metadata to the item.
      Parameters:
      meta - Meta data to apply.
      Returns:
      The current instance of the builder.

    • setLegacyName

      @Deprecated public ItemBuilder setLegacyName(@NotNull @NotNull String name)
      Deprecated.
      Set the item custom display name (colors included).
      Parameters:
      name - Display name.
      Returns:
      Current instance of the builder.

    • setName

      public ItemBuilder setName(@NotNull @NotNull net.kyori.adventure.text.Component name)

    • setLegacyLore

      @Deprecated public ItemBuilder setLegacyLore(@Nullable List<String> lore)
      Deprecated.
      Set the item description (colors included).
      Parameters:
      lore - Description lines.
      Returns:
      Current instance of the builder.

    • setLore

      public ItemBuilder setLore(@NotNull @NotNull List<net.kyori.adventure.text.Component> lore)

    • setLegacyLore

      @Deprecated public ItemBuilder setLegacyLore(@NotNull @NotNull String... lore)
      Deprecated.
      Set the item description (colors included).
      Parameters:
      lore - Descriptions lines.
      Returns:
      Current instance of the builder.

    • setLore

      public ItemBuilder setLore(@NotNull @NotNull net.kyori.adventure.text.Component... lore)

    • setUnbreakable

      public ItemBuilder setUnbreakable(boolean state)
      Set the item's unbreakable state.
      Parameters:
      state - State.
      Returns:
      Current instance of the builder.

    • addFlags

      public ItemBuilder addFlags(@NotNull @NotNull org.bukkit.inventory.ItemFlag... flags)
      Add some flags (tags) to the item.
      Parameters:
      flags - Flags.
      Returns:
      Current instance of the builder.

    • removeFlags

      public ItemBuilder removeFlags(@NotNull @NotNull org.bukkit.inventory.ItemFlag... flags)
      Remove some flags (tags) of the item.
      Parameters:
      flags - Flags.
      Returns:
      Current instance of the builder.

    • addEnchantment

      public ItemBuilder addEnchantment(@NotNull @NotNull org.bukkit.enchantments.Enchantment enchantment, int level)
      Enchant the item.
      Parameters:
      enchantment - Enchantment.
      level - Level.
      Returns:
      Current instance of the builder.

    • addEnchantments

      public ItemBuilder addEnchantments(@NotNull @NotNull Map<org.bukkit.enchantments.Enchantment,Integer> enchantments)
      Add a list of enchantments.
      Parameters:
      enchantments - Enchantments list.
      Returns:
      Current instance of the builder.

    • removeEnchantment

      public ItemBuilder removeEnchantment(@NotNull @NotNull org.bukkit.enchantments.Enchantment enchantment)
      Remove an enchantment.
      Parameters:
      enchantment - Enchantment.
      Returns:
      Current instance of the builder.

    • removeEnchantments

      public ItemBuilder removeEnchantments(@NotNull @NotNull List<org.bukkit.enchantments.Enchantment> enchantments)
      Remove a list of enchantments.
      Parameters:
      enchantments - Enchantments list.
      Returns:
      Current instance of the builder.

    • removeEnchantments

      public ItemBuilder removeEnchantments(@NotNull @NotNull org.bukkit.enchantments.Enchantment... enchantments)
      Remove a list of enchantments.
      Parameters:
      enchantments - Enchantments list.
      Returns:
      Current instance of the builder.

    • removeAllEnchantments

      public ItemBuilder removeAllEnchantments()
      Un enchant the item.
      Returns:
      Current instance of the builder.

    • setCustomModelData

      public ItemBuilder setCustomModelData(int data)
      Set the item's custom model data using a texture pack.
      Parameters:
      data - Custom model data.
      Returns:
      Current instance of the builder.