com.elikill58.negativity.api.item

Class ItemBuilder

java.lang.Object

com.elikill58.negativity.api.item.ItemBuilder

public abstract class ItemBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ItemBuilder()

Method Summary

Modifier and Type	Method and Description
abstract ItemBuilder	addToLore(String... loreToAdd) Add lore to current item
abstract ItemBuilder	amount(int amount) Set the amount of the item.
abstract ItemStack	build() Build the item.
static ItemBuilder	Builder(ItemStack item) Create an ItemBuilder with a default item.
static ItemBuilder	Builder(Material type) Create an ItemBuilder with a material.
static ItemBuilder	Builder(OfflinePlayer owner) Create an ItemBuilder for SkullItem
static ItemBuilder	Builder(Player owner) Create an ItemBuilder for SkullItem
static ItemBuilder	Builder(String type) Create an ItemBuilder with a material's name.
abstract ItemBuilder	color(DyeColor color) Edit the color Work only with colorable item like leather
abstract ItemBuilder	displayName(@Nullable String displayName) Set the display name of the item If the display name is null, the item will take the basic minecraft name
abstract ItemBuilder	enchant(Enchantment enchantment, int level) Add enchant to item
ItemBuilder	enchantIf(boolean b) (unsafe) Enchant the item if the condition success and hide it
ItemBuilder	enchantIf(Enchantment enchant, int level, boolean b) (unsafe) Enchant the item if the condition success and hide it
static ItemStack	getSkullItem(OfflinePlayer cible) Deprecated.
static ItemStack	getSkullItem(OfflinePlayer cible, Player who) Get the skull item for the given offline player Display name and lore are already set, and are according to the given player cible
static ItemStack	getSkullItem(Player cible) Deprecated.
static ItemStack	getSkullItem(Player cible, Player who) Get the skull item showed in negativity's inventory Display name and lore are already set, and are according to the given player cible
abstract ItemBuilder	itemFlag(ItemFlag... itemFlag) Add flag to this item
abstract ItemBuilder	lore(List<String> lore) Set lore to current item
abstract ItemBuilder	lore(String... lore) Set lore to current item
abstract ItemBuilder	resetDisplayName() Reset display name.
abstract ItemBuilder	unsafeEnchant(Enchantment enchantment, int level) Add enchant to item without checking if it exist As essentials, this method allow you to add enchant with level at more than max allowed by default

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemBuilder

public ItemBuilder()

Method Detail

displayName

public abstract ItemBuilder displayName(@Nullable String displayName)

Set the display name of the item If the display name is null, the item will take the basic minecraft name

Parameters:

displayName - the new name

Returns:

this builder

resetDisplayName

public abstract ItemBuilder resetDisplayName()

Reset display name. Equals as displayName(java.lang.String) if you set a null name

Returns:

this builder

enchant

public abstract ItemBuilder enchant(Enchantment enchantment,
                                    int level)

Add enchant to item

Parameters:

enchantment - the enchant name

level - the level of the enchant

Returns:

this builder

itemFlag

public abstract ItemBuilder itemFlag(ItemFlag... itemFlag)

Add flag to this item

Parameters:

itemFlag - all flag to add

Returns:

this builder

unsafeEnchant

public abstract ItemBuilder unsafeEnchant(Enchantment enchantment,
                                          int level)

Add enchant to item without checking if it exist As essentials, this method allow you to add enchant with level at more than max allowed by default

Parameters:

enchantment - the enchant name

level - the level of the enchant

Returns:

this builder

enchantIf

public ItemBuilder enchantIf(boolean b)

(unsafe) Enchant the item if the condition success and hide it

Parameters:

b - if the enchant should be applied

Returns:

this builder

enchantIf

public ItemBuilder enchantIf(Enchantment enchant,
                             int level,
                             boolean b)

(unsafe) Enchant the item if the condition success and hide it

Parameters:

enchant - the enchant to apply

level - the level of the enchant

b - if the enchant should be applied

Returns:

this builder

amount

public abstract ItemBuilder amount(int amount)

Set the amount of the item. Default: 1

Parameters:

amount - the new amount of item

Returns:

this builder

color

public abstract ItemBuilder color(DyeColor color)

Edit the color Work only with colorable item like leather

Parameters:

color - the new item color

Returns:

this builder

lore

public abstract ItemBuilder lore(List<String> lore)

Set lore to current item

Parameters:

lore - the new lore list

Returns:

this builder

lore

public abstract ItemBuilder lore(String... lore)

Set lore to current item

Parameters:

lore - the new lore list

Returns:

this builder

addToLore

public abstract ItemBuilder addToLore(String... loreToAdd)

Add lore to current item

Parameters:

loreToAdd - Lore lines which must to be added

Returns:

this builder

build

public abstract ItemStack build()

Build the item.

Returns:

the usable item

Builder

public static ItemBuilder Builder(Material type)

Create an ItemBuilder with a material.

Parameters:

type - the material of the item

Returns:

the item builder

Builder

public static ItemBuilder Builder(ItemStack item)

Create an ItemBuilder with a default item.

Parameters:

item - the beginning item

Returns:

the item builder

Builder

public static ItemBuilder Builder(String type)

Create an ItemBuilder with a material's name. Compatible with "type:byte" for 1.12 and less items

Parameters:

type - the type descriptor for the desired material

Returns:

the item builder

Builder

public static ItemBuilder Builder(Player owner)

Create an ItemBuilder for SkullItem

Parameters:

owner - the owner of the skull

Returns:

the builder for skull item

Builder

public static ItemBuilder Builder(OfflinePlayer owner)

Create an ItemBuilder for SkullItem

Parameters:

owner - the owner of the skull

Returns:

the builder for skull item

getSkullItem

@Deprecated
public static ItemStack getSkullItem(Player cible)

Deprecated.

Get the skull item showed in negativity's inventory Display name and lore are already set, and are according to the given player cible

Parameters:

cible - the owner of the skull item

Returns:

the skull item which will be set in inventory

getSkullItem

public static ItemStack getSkullItem(Player cible,
                                     Player who)

Get the skull item showed in negativity's inventory Display name and lore are already set, and are according to the given player cible

Parameters:

cible - the owner of the skull item

who - the player that will see this skull

Returns:

the skull item which will be set in inventory

getSkullItem

@Deprecated
public static ItemStack getSkullItem(OfflinePlayer cible)

Deprecated.

Get the skull item for the given offline player
Prefer use getSkullItem(OfflinePlayer, Player) to get it translate in good language

Parameters:

cible - offline player

Returns:

the skull item

getSkullItem

public static ItemStack getSkullItem(OfflinePlayer cible,
                                     Player who)

Get the skull item for the given offline player
Display name and lore are already set, and are according to the given player cible

Parameters:

cible - the owner of the skull item

who - the player that will see this skull

Returns:

the skull item which will be set in inventory