com.chrismin13.additionsapi.items

Class CustomItem

java.lang.Object

com.chrismin13.additionsapi.items.CustomItem

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<CustomItem>

Direct Known Subclasses:

CustomArmor, CustomBow, CustomTexturedItem, CustomTool

public class CustomItem
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<CustomItem>

A Custom Item with multiple values that can be changed.

If you want Custom Items with Custom Textures, see CustomTexturedItem
If you want to use this for tools (Sword, Axe, Pickaxe, Shovel, Hoe), use CustomTool instead. There are similar classes available for other ItemTypes too, such as Leather Armor.

In order to use the Custom Items in-game, you can register them using the AdditionsAPIInitializationEvent. That way, Recipes and Custom Textures will be functional.
If you want to get an ItemStack for giving it to the player, make a new CustomItemStack and get the ItemStack from there.

Author:

chrismin13

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.UUID	CHEST_UUID The UUID of the Attribute that will be applied to the Chestplate Slot.
static java.util.UUID	FEET_UUID The UUID of the Attribute that will be applied to the Boots Slot.
static java.util.UUID	HEAD_UUID The UUID of the Attribute that will be applied to the Head Slot.
static java.util.UUID	LEGS_UUID The UUID of the Attribute that will be applied to the Leggings Slot.
static java.lang.String	LORE_PREFIX
static java.lang.String	LORE_SUFFIX
static java.util.UUID	MAIN_HAND_UUID The UUID of the Attribute that will be applied to the Main Hand Slot.
static java.util.UUID	OFF_HAND_UUID The UUID of the Attribute that will be applied to the Off Hand Slot.

Constructor Summary

Constructors

Constructor and Description
CustomItem(org.bukkit.Material material, int amount, short durability, java.lang.String idName) Create a new Custom Item.
CustomItem(org.bukkit.Material material, int amount, short durability, java.lang.String idName, ItemDurability itemDurability) Create a new Custom Item.
CustomItem(org.bukkit.Material material, int amount, short durability, java.lang.String idName, ItemDurability itemDurability, ItemPermissions itemPermissions) Create a new Custom Item.

Method Summary

Modifier and Type	Method and Description
CustomItem	addAllCustomRecipes(java.util.List<? extends CustomRecipe> recipes) Adds all of the specified recipes to the list of CustomShapedRecipes.
CustomItem	addAttribute(Attributes.AttributeType type, double amount, org.bukkit.inventory.EquipmentSlot slot, Attributes.Operation operation) Adds an Attribute to the CustomItem.
CustomItem	addAttribute(Attributes.AttributeType type, double amount, org.bukkit.inventory.EquipmentSlot slot, Attributes.Operation operation, java.util.UUID uuid) Adds an Attribute to the CustomItem.
CustomItem	addAttribute(java.lang.String name, Attributes.AttributeType type, double amount, org.bukkit.inventory.EquipmentSlot slot, Attributes.Operation operation, java.util.UUID uuid) Adds an Attribute to the CustomItem.
CustomItem	addCustomRecipe(CustomRecipe recipe) Adds the specified recipe to the list of CustomShapedRecipes.
CustomItem	addEnchantment(org.bukkit.enchantments.Enchantment enchantment, int level) Adds an Enchantment to the CustomItem.
CustomItem	addForbiddenEnchantment(org.bukkit.enchantments.Enchantment forbiddenEnchantment) Add an Enchantment to the list of forbidden enchants.
CustomItem	addForbiddenEnchantment(java.util.List<org.bukkit.enchantments.Enchantment> forbiddenEnchantments) Add an Enchantment list to the list of forbidden enchants.
CustomItem	addItemFlag(org.bukkit.inventory.ItemFlag itemFlag) Add an ItemFlag to the CustomItem.
CustomItem	addLoreLine(java.lang.String lore) Adds a line to the Lore that will be included with the CustomItem.
CustomItem	clearAttributes() Remove all Attribtues from the Custom Item
CustomItem	clone()
int	compareTo(CustomItem cItem) Compare the CustomItems in regards to their durability.
int	getAmount()
java.util.List<Attributes.Attribute>	getAttributes()
boolean	getAttributeVisibility()
int	getBurnTime()
boolean	getCanBePlacedVisibility()
boolean	getCanDestroyVisibility()
java.util.List<CustomRecipe>	getCustomRecipes()
java.lang.String	getDisplayName()
short	getDurability()
ItemDurability	getDurabilityMechanics()
boolean	getEnchantmentVisibility()
java.util.HashMap<org.bukkit.enchantments.Enchantment,java.lang.Integer>	getEnchantmnets()
int	getFakeDurability()
java.util.List<org.bukkit.enchantments.Enchantment>	getForbidenEnchantments() Get a List of the Enchantments that are not allowed for this item.
java.util.List<java.lang.String>	getFullLore(java.util.Map<org.bukkit.enchantments.Enchantment,java.lang.Integer> map, int durability, Attributes attributes)
java.lang.String	getIdName()
java.util.List<org.bukkit.inventory.ItemFlag>	getItemFlags()
ItemType	getItemType()
java.util.List<java.lang.String>	getLore()
org.bukkit.Material	getMaterial()
ItemPermissions	getPermissions()
boolean	getPotionEffectsVisibility()
boolean	getUnbreakableVisibility()
boolean	hasFakeDurability()
boolean	hasHoeAbilities() ONLY APPLICABLE FOR HOES This is useful if you would like to create a Custom Item with no special abilities.
boolean	isCombinableInCrafting()
boolean	isEnchantable()
boolean	isUnbreakable()
CustomItem	setAmount(int amount) Set the Amount of the Custom Item
CustomItem	setAttributes(java.util.List<Attributes.Attribute> attributes)
CustomItem	setAttributeVisibility(boolean attributeVisibility) Set whether the attribute text in the item lore will be visible or not.
CustomItem	setBurnTime(int ticks) Set the burn time of a Custom Item in ticks when placed in a furnace.
CustomItem	setCanBePlacedVisibility(boolean canBePlacedVisibility) Set whether the text that shows on which blocks this can be placed on in the item lore is visible or not.
CustomItem	setCanDestroyVisibility(boolean canDestroyVisibility) Set whether the text that shows which blocks this item can mine in the item lore is visible or not.
CustomItem	setCombinedInCrafting(boolean canBeCombined) Set if the item can be Combined in a Crafting Table.
CustomItem	setDisplayName(java.lang.String displayName) Set the display name of the Custom Item.
CustomItem	setDurability(short durabilityShort) Set the Durability of the Custom Item.
CustomItem	setDurabilityMechanics(ItemDurability itemDurability) These determine how the durability of the CustomItem, both for Fake and real durability, will drop.
CustomItem	setEnchantable(boolean canBeEnchanted) Set if the item can be Enchanted.
CustomItem	setEnchantmentVisibility(boolean enchantmentVisibility) Set whether the enchantments in the item lore are visible or not.
CustomItem	setFakeDurability(int durability) Sets the Durability for the Fake Durability lore.
CustomItem	setHoeAbilities(boolean hoeAbilities) ONLY APPLICABLE FOR HOES This is useful if you would like to create a Custom Item with no special abilities.
CustomItem	setIdName(java.lang.String IdName) Set the CustomItem's IdName.
CustomItem	setLore(java.util.List<java.lang.String> string) Set the lore of the CustomItem.
CustomItem	setMaterial(org.bukkit.Material material) Set the Material of the Custom Item
void	setPermissions(ItemPermissions permissions) Set the Permission System for the Custom Item.
CustomItem	setPotionEffectsVisibility(boolean potionEffectVisibility) Set whether the text that shows the potion effect this item will include when consumed in the item lore is visible or not.
CustomItem	setUnbreakable(java.lang.Boolean unbreakable) Set the Custom Item to be Unbreakable or not.
CustomItem	setUnbreakableVisibility(boolean unbreakableVisibility) Set whether the unbreakable tag in the item lore will be visible or not.

Methods inherited from class java.lang.Object

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

Field Detail

LORE_PREFIX

public static final java.lang.String LORE_PREFIX

LORE_SUFFIX

public static final java.lang.String LORE_SUFFIX

MAIN_HAND_UUID

public static final java.util.UUID MAIN_HAND_UUID

The UUID of the Attribute that will be applied to the Main Hand Slot. This value is NOT taken from the Minecraft Source Code, but instead I just set it as a random UUID, due to not being able to find what the UUID is in Vanilla Minecraft.

OFF_HAND_UUID

public static final java.util.UUID OFF_HAND_UUID

The UUID of the Attribute that will be applied to the Off Hand Slot. This value is NOT taken from the Minecraft Source Code, but instead I just set it as a random UUID, due to not being able to find what the UUID is in Vanilla Minecraft.

HEAD_UUID

public static final java.util.UUID HEAD_UUID

The UUID of the Attribute that will be applied to the Head Slot. This value is taken straight from the Minecraft Source Code.

CHEST_UUID

public static final java.util.UUID CHEST_UUID

The UUID of the Attribute that will be applied to the Chestplate Slot. This value is taken straight from the Minecraft Source Code.

LEGS_UUID

public static final java.util.UUID LEGS_UUID

The UUID of the Attribute that will be applied to the Leggings Slot. This value is taken straight from the Minecraft Source Code.

FEET_UUID

public static final java.util.UUID FEET_UUID

The UUID of the Attribute that will be applied to the Boots Slot. This value is taken straight from the Minecraft Source Code.

Constructor Detail

CustomItem

public CustomItem(org.bukkit.Material material,
                  int amount,
                  short durability,
                  java.lang.String idName)

Create a new Custom Item.

Parameters:

material - the material of the CustomItem

amount - the amount of the CustomItem

durability - the durability of the CustomItem

idName - the Custom Item's ID Name. This MUST BE SIMILAR to "vanilla_additions:emerald_sword" and is saved in the ItemStack so you can easily detect which Custom Item it is.

CustomItem

public CustomItem(org.bukkit.Material material,
                  int amount,
                  short durability,
                  java.lang.String idName,
                  ItemDurability itemDurability)

Create a new Custom Item.

Parameters:

material - the material of the CustomItem

amount - the amount of the CustomItem

durability - the durability of the CustomItem

itemDurability - the ItemDurability Durability System that will be used for the Item. This will modify the way that durability drops for the Custom Item. All Classes under package com.chrismin13.additionsapi.durability are valid.

idName - the Custom Item's ID Name. This MUST BE SIMILAR to "vanilla_additions:emerald_sword" and is saved in the ItemStack so you can easily detect which Custom Item it is.

CustomItem

public CustomItem(org.bukkit.Material material,
                  int amount,
                  short durability,
                  java.lang.String idName,
                  ItemDurability itemDurability,
                  ItemPermissions itemPermissions)

Create a new Custom Item.

Parameters:

material - the material of the CustomItem

amount - the amount of the CustomItem

durability - the durability of the CustomItem

itemDurability - the ItemDurability Durability System that will be used for the Item. This will modify the way that durability drops for the Custom Item. All Classes under package com.chrismin13.additionsapi.durability are valid.

idName - the Custom Item's ID Name. This MUST BE SIMILAR to "vanilla_additions:emerald_sword" and is saved in the ItemStack so you can easily detect which Custom Item it is.

Method Detail

getMaterial

public org.bukkit.Material getMaterial()

Returns:

The Material of the Custom Item

getAmount

public int getAmount()

Returns:

The Amount of the Custom Item

getDurability

public short getDurability()

Returns:

The Durability of the Custom Item. This will be the durability of the default texture for a CustomTexturedItem. If the TexturedItem was not processed during the AdditionsAPIInitializationEvent, it will be always 0.

setMaterial

public CustomItem setMaterial(org.bukkit.Material material)

Set the Material of the Custom Item

setAmount

public CustomItem setAmount(int amount)

Set the Amount of the Custom Item

setDurability

public CustomItem setDurability(short durabilityShort)

Set the Durability of the Custom Item. You may not use this method on TexturedItems as it will mess up the durability of the default texture.

getItemType

public ItemType getItemType()

isUnbreakable

public boolean isUnbreakable()

Returns:

Boolean that states if the item is unbreakable or not. However, just because the Item is unbreakable doesn't mean that it will not have it's durability reduced as it can have Fake Durability.

setUnbreakable

public CustomItem setUnbreakable(java.lang.Boolean unbreakable)

Set the Custom Item to be Unbreakable or not. However, just because you set Item to be unbreakable doesn't mean that it will not have it's durability reduced as it can have Fake Durability.

getDisplayName

public java.lang.String getDisplayName()

Returns:

The Display Name of the Custom Item.

setDisplayName

public CustomItem setDisplayName(java.lang.String displayName)

Set the display name of the Custom Item. By default, it will add ChatColor.RESET in front to prevent the slanted text. You can override that by adding another ChatColor afterwards, however be aware that it will show up if you rename the item in an anvil.

getIdName

public java.lang.String getIdName()

Returns:

String - the CustomItem's IdName. This has a similar format to the ones found in vanila, e.g. vanilla_additions:emerald_sword, and are saved using an nbt tag in the ItemStack. You can get the IdName from any itemstack by using AdditionsAPI.getIdName or creating a CustomItemStack and getting the idName from there.

setIdName

public CustomItem setIdName(java.lang.String IdName)

Set the CustomItem's IdName. This has a similar format to the ones found in vanila, e.g. vanilla_additions:emerald_sword, and are saved using an nbt tag in the ItemStack. You can get the IdName from any itemstack by using AdditionsAPI.getIdName or creating a CustomItemStack and getting the idName from there.

getForbidenEnchantments

public java.util.List<org.bukkit.enchantments.Enchantment> getForbidenEnchantments()

Get a List of the Enchantments that are not allowed for this item. These will be checked when using an Enchantment Table or an Anvil to add Enchantments.

addForbiddenEnchantment

public CustomItem addForbiddenEnchantment(org.bukkit.enchantments.Enchantment forbiddenEnchantment)

Add an Enchantment to the list of forbidden enchants. Any Enchantments that are added will not be able to be added to the ItemStack neither from an Enchantment Table, nor from an Anvil.

addForbiddenEnchantment

public CustomItem addForbiddenEnchantment(java.util.List<org.bukkit.enchantments.Enchantment> forbiddenEnchantments)

Add an Enchantment list to the list of forbidden enchants. Any Enchantments that are added will not be able to be added to the ItemStack neither from an Enchantment Table, nor from an Anvil.

isEnchantable

public boolean isEnchantable()

Returns:

boolean - If the Item can be Enchanted. If it cannot be enchanted then after choosing an Enchantment in an Enchantment Table or adding a Book in an Anvil, it will not do anything.

setEnchantable

public CustomItem setEnchantable(boolean canBeEnchanted)

Set if the item can be Enchanted. If it cannot be enchanted then after choosing an Enchantment in an Enchantment Table or adding a Book in an Anvil, it will not do anything.

isCombinableInCrafting

public boolean isCombinableInCrafting()

Returns:

boolean - If the Item can be Combined in a Crafting Table. If it cannot be, then adding two of the same items in a Crafting Table will not give any result.

setCombinedInCrafting

public CustomItem setCombinedInCrafting(boolean canBeCombined)

Set if the item can be Combined in a Crafting Table. If it cannot be, then adding two of the same items in a Crafting Table will not give any result.

getCustomRecipes

public java.util.List<CustomRecipe> getCustomRecipes()

Returns:

List - Returns a List of CustomShapedRecipes. These recipes behave a lot like the Custom Recipes already found in Bukkit and are converted to that format upon initialization. See CustomShapedRecipe.

addCustomRecipe

public CustomItem addCustomRecipe(CustomRecipe recipe)

Adds the specified recipe to the list of CustomShapedRecipes. These recipes behave a lot like the Custom Recipes already found in Bukkit and are converted to that format upon initialization. See CustomShapedRecipe.

addAllCustomRecipes

public CustomItem addAllCustomRecipes(java.util.List<? extends CustomRecipe> recipes)

Adds all of the specified recipes to the list of CustomShapedRecipes. These recipes behave a lot like the Custom Recipes already found in Bukkit and are converted to that format upon initialization. See CustomShapedRecipe.

addAttribute

public CustomItem addAttribute(Attributes.AttributeType type,
                               double amount,
                               org.bukkit.inventory.EquipmentSlot slot,
                               Attributes.Operation operation)

Adds an Attribute to the CustomItem. If you don't know what they do or how they work, check out the Minecraft wiki. The UUID will be the one that is found by default in Minecraft for the specified Slot. The name will be, as a placeholder, TBD (which means To Be Determined).

Parameters:

type - The attribute that will be added.

amount - The amount of the attribute. Can also be a negative value.

slot - The EquipmentSlot at which the Attribute will be applied. For example, the EquipmentSlot HAND will apply the specified Attribute to the Main Hand only.

operation - The math operation that will be used for the amount specified.

addAttribute

public CustomItem addAttribute(Attributes.AttributeType type,
                               double amount,
                               org.bukkit.inventory.EquipmentSlot slot,
                               Attributes.Operation operation,
                               java.util.UUID uuid)

Adds an Attribute to the CustomItem. If you don't know what they do or how they work, check out the Minecraft wiki. The name will be "Additions API Attribute".

Parameters:

type - The attribute that will be added.

amount - The amount of the attribute. Can also be a negative value.

slot - The EquipmentSlot at which the Attribute will be applied. For example, the EquipmentSlot HAND will apply the specified Attribute to the Main Hand only.

operation - The math operation that will be used for the amount specified.

uuid - The UUID that the Attribute will be saved with in the ItemStack.

addAttribute

public CustomItem addAttribute(java.lang.String name,
                               Attributes.AttributeType type,
                               double amount,
                               org.bukkit.inventory.EquipmentSlot slot,
                               Attributes.Operation operation,
                               java.util.UUID uuid)

Adds an Attribute to the CustomItem. If you don't know what they do or how they work, check out the Minecraft wiki.

Parameters:

name - The name that the Attribute will have. Can be anything, doesn't have to match the Attribute.

type - The attribute that will be added.

amount - The amount of the attribute. Can also be a negative value.

slot - The EquipmentSlot at which the Attribute will be applied. For example, the EquipmentSlot HAND will apply the specified Attribute to the Main Hand only.

operation - The math operation that will be used for the amount specified.

uuid - The UUID that the Attribute will be saved with in the ItemStack.

getAttributes

public java.util.List<Attributes.Attribute> getAttributes()

Returns:

List - A list of Attributes that will be included with the Custom Item. If you don't know what they do or how they work, check out the Minecraft wiki.

setAttributes

public CustomItem setAttributes(java.util.List<Attributes.Attribute> attributes)

Parameters:

attributes - A list of Attributes that will be included with the Custom Item. If you don't know what they do or how they work, check out the Minecraft wiki.

clearAttributes

public CustomItem clearAttributes()

Remove all Attribtues from the Custom Item

addItemFlag

public CustomItem addItemFlag(org.bukkit.inventory.ItemFlag itemFlag)

Add an ItemFlag to the CustomItem.

getItemFlags

public java.util.List<org.bukkit.inventory.ItemFlag> getItemFlags()

Returns:

List - A list of all ItemFlags included in the CustomItem.

getAttributeVisibility

public boolean getAttributeVisibility()

Returns:

Boolean of whether the attribute text in the item lore is visible or not. If it is true, then the text is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_Attribute

setAttributeVisibility

public CustomItem setAttributeVisibility(boolean attributeVisibility)

Set whether the attribute text in the item lore will be visible or not. If it is set true, then the text will be visible. If it is set to be hidden then the CustomItem includes the ItemFlag HIDE_ATTRIBUTES

getUnbreakableVisibility

public boolean getUnbreakableVisibility()

Returns:

Boolean of whether the unbreakable tag in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_UNBREAKABLE

setUnbreakableVisibility

public CustomItem setUnbreakableVisibility(boolean unbreakableVisibility)

Set whether the unbreakable tag in the item lore will be visible or not. If it is set true, then the tag will be visible. If it is set to be hidden then the CustomItem includes the ItemFlag HIDE_UNBREAKABLE

getCanDestroyVisibility

public boolean getCanDestroyVisibility()

Returns:

Boolean of whether the text that shows which blocks this item can mine in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_DESTROYS

setCanDestroyVisibility

public CustomItem setCanDestroyVisibility(boolean canDestroyVisibility)

Set whether the text that shows which blocks this item can mine in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_DESTROYS

getEnchantmentVisibility

public boolean getEnchantmentVisibility()

Returns:

Boolean of whether the enchantments in the item lore are visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_ENCHANTS

setEnchantmentVisibility

public CustomItem setEnchantmentVisibility(boolean enchantmentVisibility)

Set whether the enchantments in the item lore are visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_ENCHANTS

getCanBePlacedVisibility

public boolean getCanBePlacedVisibility()

Returns:

Boolean of whether the text that shows on which blocks this can be placed on in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_PLACED_ON

setCanBePlacedVisibility

public CustomItem setCanBePlacedVisibility(boolean canBePlacedVisibility)

Set whether the text that shows on which blocks this can be placed on in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_PLACED_ON

getPotionEffectsVisibility

public boolean getPotionEffectsVisibility()

Returns:

Boolean of whether the text that shows the potion effect this item will include when consumed in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_POTION_EFFECTS

setPotionEffectsVisibility

public CustomItem setPotionEffectsVisibility(boolean potionEffectVisibility)

Set whether the text that shows the potion effect this item will include when consumed in the item lore is visible or not. If it is true, then the tag is visible. If it is invisible then the CustomItem includes the ItemFlag HIDE_POTION_EFFECTS

setFakeDurability

public CustomItem setFakeDurability(int durability)

Sets the Durability for the Fake Durability lore. The fake durability lore offers a near perfect recreation of the Minecraft durability mechanics but hidden in the lore. This way, Textured Items that have to be unbreakable can still have durability mechanics.

Parameters:

durability - The maximum durability of the CustomItem and the one that it will be starting with. Any number above 0 will enable the fake durability lore. If it is 0 then it will not be enabled.

getFakeDurability

public int getFakeDurability()

Returns:

int - The maximum fake durability of the CustomItem. If this is above 0, then the Fake Durability lore is enabled. The fake durability lore offers a near perfect recreation of the Minecraft durability mechanics but hidden in the lore. This way, Textured Items that have to be unbreakable can still have durability mechanics.

hasFakeDurability

public boolean hasFakeDurability()

Returns:

boolean - Whether the Custom Item will include the Fake Durability lore or not. If the fake durability above 0, then the Fake Durability lore is enabled. The fake durability lore offers a near perfect recreation of the Minecraft durability mechanics but hidden in the lore. This way, Textured Items that have to be unbreakable can still have durability mechanics.

getEnchantmnets

public java.util.HashMap<org.bukkit.enchantments.Enchantment,java.lang.Integer> getEnchantmnets()

Returns:

Map - A map of the Enchantments included in the CustomItem and their level.

addEnchantment

public CustomItem addEnchantment(org.bukkit.enchantments.Enchantment enchantment,
                                 int level)

Adds an Enchantment to the CustomItem.

Parameters:

enchantment - The Enchantment to add.

level - The level of the Enchantment. Set this to 1 if the Enchantment doesn't have multiple levels by default.

addLoreLine

public CustomItem addLoreLine(java.lang.String lore)

Adds a line to the Lore that will be included with the CustomItem. This will go above the CustomTool's Fake Attack Speed and Attack Damage Lore and the CustomItem's Fake Durability lore.

setLore

public CustomItem setLore(java.util.List<java.lang.String> string)

Set the lore of the CustomItem. This will go above the CustomTool's Fake Attack Speed and Attack Damage Lore and the CustomItem's Fake Durability lore.

getLore

public java.util.List<java.lang.String> getLore()

Returns:

List - The lore of the Custom Item. This does not include the CustomTool's Fake Attack Speed and Attack Damage Lore or the CustomItem's Fake Durability lore.

getFullLore

public java.util.List<java.lang.String> getFullLore(java.util.Map<org.bukkit.enchantments.Enchantment,java.lang.Integer> map,
                                                    int durability,
                                                    Attributes attributes)

Parameters:

map - The Enchantments that will be taken into consideration when creating the lore. Currently, only the Sharpness Enchantment and its Level have to be taken into consideration.

durability - The current fake durability that will be added if the CustomItem has fake Durability.

Returns:

List - The lore of the Custom Item. This includes the CustomTool's Fake Attack Speed and Attack Damage Lore and the CustomItem's Fake Durability lore that have been customized according to the specified parameters.

clone

public CustomItem clone()

Overrides:

clone in class java.lang.Object

compareTo

public int compareTo(CustomItem cItem)

Compare the CustomItems in regards to their durability. Used for generating the Resource Pack.

Specified by:

compareTo in interface java.lang.Comparable<CustomItem>

getDurabilityMechanics

public ItemDurability getDurabilityMechanics()

Returns:

ItemDurability - The ItemDurability mechanics. These determine how the durability of the CustomItem, both for Fake and real durability, will drop.

setDurabilityMechanics

public CustomItem setDurabilityMechanics(ItemDurability itemDurability)

These determine how the durability of the CustomItem, both for Fake and real durability, will drop.

Parameters:

itemDurability - the itemDurability to set. Every class under the package com.chrismin13.additionsapi.durability is valid.

Returns:

hasHoeAbilities

public boolean hasHoeAbilities()

ONLY APPLICABLE FOR HOES
This is useful if you would like to create a Custom Item with no special abilities. Most people use Diamond Hoes for Custom Items due to their high durability count and their block breaking speed that is the same as the player's hand. However, upon right click they hoe Grass and Dirt along with playing a sound. So, what this does, is it removes both the sound and the ability to hoe.
Don't forget to also use #addAttribute(AttributeType.ATTACK_DAMAGE, 0.0D, EquipmentSlot.HAND, Operation.ADD_NUMBER) to remove the hoe's extra attack damage and #setAttributeVisibility(false) to remove the Attribute Lore. Attack Speed will be reset as well.

Returns:

Whether the CustomItem that is a hoe will keep its ability to till grass and its sounds.

setHoeAbilities

public CustomItem setHoeAbilities(boolean hoeAbilities)

ONLY APPLICABLE FOR HOES
This is useful if you would like to create a Custom Item with no special abilities. Most people use Diamond Hoes for Custom Items due to their high durability count and their block breaking speed that is the same as the player's hand. However, upon right click they hoe Grass and Dirt along with playing a sound. So, what this does, is it removes both the sound and the ability to hoe.
Don't forget to also use #addAttribute(AttributeType.ATTACK_DAMAGE, 0.0D, EquipmentSlot.HAND, Operation.ADD_NUMBER) to remove the hoe's extra attack damage and #setAttributeVisibility(false) to remove the Attribute Lore. Attack Speed will be reset as well.

Parameters:

hoeAbilities - Whether the Hoe should keep its abilities or not.

getPermissions

public ItemPermissions getPermissions()

Returns:

The Permission System for the Custom Item.

setPermissions

public void setPermissions(ItemPermissions permissions)

Set the Permission System for the Custom Item.

Parameters:

permissions -

getBurnTime

public int getBurnTime()

Returns:

The burn time of a Custom Item in ticks when placed in a furnace. This is only compatible with items that can be burnt in a furnace already.

setBurnTime

public CustomItem setBurnTime(int ticks)

Set the burn time of a Custom Item in ticks when placed in a furnace. This is only compatible with items that can be burnt in a furnace already.