me.mattstudios.mfgui.gui.components

Class ItemBuilder

java.lang.Object

me.mattstudios.mfgui.gui.components.ItemBuilder

public final class ItemBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ItemBuilder(@NotNull org.bukkit.inventory.ItemStack itemStack) Deprecated. Use from(ItemStack) instead, it's more idiomatic for a builder
ItemBuilder(org.bukkit.Material material) Deprecated. Use from(Material) instead, it's more idiomatic for a builder

Method Summary

Modifier and Type	Method and Description
ItemBuilder	addEnchantment(@NotNull org.bukkit.enchantments.Enchantment enchantment) Add enchantment to an item
ItemBuilder	addEnchantment(@NotNull org.bukkit.enchantments.Enchantment enchantment, int level) Add enchantment to an item
ItemBuilder	addEnchantment(@NotNull org.bukkit.enchantments.Enchantment enchantment, int level, boolean ignoreLevelRestriction) Add enchantment to an item
ItemBuilder	addItemFlags(org.bukkit.inventory.ItemFlag... flags) Add a custom ItemFlag to the item
GuiItem	asGuiItem()
GuiItem	asGuiItem(@NotNull GuiAction<org.bukkit.event.inventory.InventoryClickEvent> action)
org.bukkit.inventory.ItemStack	build() Builds the item into ItemStack
static ItemBuilder	from(@NotNull org.bukkit.inventory.ItemStack itemStack) Main method to create ItemBuilder
static ItemBuilder	from(@NotNull org.bukkit.Material material) Alternative method to create ItemBuilder
ItemBuilder	glow(boolean glow) Makes the Item glow
ItemBuilder	removeEnchantment(@NotNull org.bukkit.enchantments.Enchantment enchantment) Removes a certain Enchantment from the item
ItemBuilder	setAmount(int amount) Sets the amount of items
ItemBuilder	setLore(@NotNull List<String> lore) Set the lore lines of an item
ItemBuilder	setLore(String... lore) Set the lore lines of an item
ItemBuilder	setName(@NotNull String name) Set display name of the item
ItemBuilder	setNbt(@NotNull String key, @NotNull String value) Sets NBT tag to the ItemStack
ItemBuilder	setSkullOwner(@NotNull org.bukkit.OfflinePlayer player) Sets skull owner via bukkit methods
ItemBuilder	setSkullTexture(@NotNull String texture) Sets the skull texture
ItemBuilder	setUnbreakable(boolean unbreakable) Sets the item as unbreakable

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemBuilder

@Deprecated
public ItemBuilder(@NotNull
                                @NotNull org.bukkit.inventory.ItemStack itemStack)

Deprecated. Use from(ItemStack) instead, it's more idiomatic for a builder

Constructor of the item builder

Parameters:

itemStack - The ItemStack of the item

ItemBuilder

@Deprecated
public ItemBuilder(org.bukkit.Material material)

Deprecated. Use from(Material) instead, it's more idiomatic for a builder

Alternative constructor with Material

Parameters:

material - The Material of the ItemStack

Method Detail

from

public static ItemBuilder from(@NotNull
                               @NotNull org.bukkit.inventory.ItemStack itemStack)

Main method to create ItemBuilder

Parameters:

itemStack - The ItemStack you want to edit

Returns:

A new ItemBuilder

from

public static ItemBuilder from(@NotNull
                               @NotNull org.bukkit.Material material)

Alternative method to create ItemBuilder

Parameters:

material - The Material you want to create an item from

Returns:

A new ItemBuilder

build

public org.bukkit.inventory.ItemStack build()

Builds the item into ItemStack

Returns:

The fully built ItemStack

asGuiItem

public GuiItem asGuiItem()

asGuiItem

public GuiItem asGuiItem(@NotNull
                         @NotNull GuiAction<org.bukkit.event.inventory.InventoryClickEvent> action)

setName

public ItemBuilder setName(@NotNull
                           @NotNull String name)

Set display name of the item

Parameters:

name - the display name of the item

Returns:

ItemBuilder

setAmount

public ItemBuilder setAmount(int amount)

Sets the amount of items

Parameters:

amount - the amount of items

Returns:

ItemBuilder

setLore

public ItemBuilder setLore(@NotNull
                           String... lore)

Set the lore lines of an item

Parameters:

lore - the lore lines to set

Returns:

ItemBuilder

setLore

public ItemBuilder setLore(@NotNull
                           @NotNull List<String> lore)

Set the lore lines of an item

Parameters:

lore - A List with the lore lines

Returns:

ItemBuilder

addEnchantment

public ItemBuilder addEnchantment(@NotNull
                                  @NotNull org.bukkit.enchantments.Enchantment enchantment,
                                  int level,
                                  boolean ignoreLevelRestriction)

Add enchantment to an item

Parameters:

enchantment - the Enchantment to add

level - the level of the Enchantment

ignoreLevelRestriction - If should or not ignore it

Returns:

ItemBuilder

addEnchantment

public ItemBuilder addEnchantment(@NotNull
                                  @NotNull org.bukkit.enchantments.Enchantment enchantment,
                                  int level)

Add enchantment to an item

Parameters:

enchantment - the Enchantment to add

level - the level of the Enchantment

Returns:

ItemBuilder

addEnchantment

public ItemBuilder addEnchantment(@NotNull
                                  @NotNull org.bukkit.enchantments.Enchantment enchantment)

Add enchantment to an item

Parameters:

enchantment - the Enchantment to add

Returns:

ItemBuilder

removeEnchantment

public ItemBuilder removeEnchantment(@NotNull
                                     @NotNull org.bukkit.enchantments.Enchantment enchantment)

Removes a certain Enchantment from the item

Parameters:

enchantment - The Enchantment to remove

Returns:

ItemBuilder

addItemFlags

public ItemBuilder addItemFlags(@NotNull
                                org.bukkit.inventory.ItemFlag... flags)

Add a custom ItemFlag to the item

Parameters:

flags - the ItemFlag to add

Returns:

ItemBuilder

setUnbreakable

public ItemBuilder setUnbreakable(boolean unbreakable)

Sets the item as unbreakable

Parameters:

unbreakable - If should or not be unbreakable

Returns:

ItemBuilder

glow

public ItemBuilder glow(boolean glow)

Makes the Item glow

Parameters:

glow - Should the item glow

Returns:

ItemBuilder

setSkullTexture

public ItemBuilder setSkullTexture(@NotNull
                                   @NotNull String texture)

Sets the skull texture

Parameters:

texture - The base64 texture

Returns:

ItemBuilder

setSkullOwner

public ItemBuilder setSkullOwner(@NotNull
                                 @NotNull org.bukkit.OfflinePlayer player)

Sets skull owner via bukkit methods

Parameters:

player - OfflinePlayer to set skull of

Returns:

ItemBuilder

setNbt

public ItemBuilder setNbt(@NotNull
                          @NotNull String key,
                          @NotNull
                          @NotNull String value)

Sets NBT tag to the ItemStack

Parameters:

key - The NBT key

value - The NBT value

Returns:

ItemBuilder