com.chrismin13.additionsapi.items

Class CustomItemStack

java.lang.Object

com.chrismin13.additionsapi.items.CustomItemStack

All Implemented Interfaces:

java.lang.Cloneable

public class CustomItemStack
extends java.lang.Object
implements java.lang.Cloneable

A CustomItemStack contains an ItemStack and a Custom Item. Especially useful if you want to get the ItemStack of a Custom Item or vice versa.

Author:

chrismin13

Constructor Summary

Constructors

Constructor and Description
CustomItemStack(CustomItem cItem) Create a new CustomItemStack.
CustomItemStack(CustomItem cItem, short durability, java.lang.String texture) Create a new CustomItemStack.
CustomItemStack(org.bukkit.inventory.ItemStack item) Create a new CustomItemStack.
CustomItemStack(java.lang.String idName) Create a new CustomItemStack. Durability and Texture will be the default values.
CustomItemStack(java.lang.String idName, short durability, java.lang.String texture) Create a new CustomItemStack.

Method Summary

Modifier and Type	Method and Description
void	addAllNBTData(java.util.Map<? extends java.lang.String,? extends java.lang.Object> nbtData) Add all NBT Data from a Map.
void	addAttribute(Attributes.AttributeType type, java.lang.String name, double amount, java.util.UUID uuid, org.bukkit.inventory.EquipmentSlot slot, Attributes.Operation operation) Add an attribute to the ItemStack.
void	addNBTData(java.lang.String nbtKey, java.lang.Object nbtData) Add NBT Data.
CustomItemStack	clone()
Attributes	getAttributes()
CustomItem	getCustomItem()
int	getFakeDurability()
org.bukkit.inventory.ItemStack	getItemStack()
int	getMaxFakeDurability()
NbtFactory.NbtCompound	getNBTData()
java.lang.String	getTexture()
CustomItemStack	reduceDurability(org.bukkit.entity.Player player, int durabilityToReduce) Reduces the durability of the CustomItemStack, whether it's using Fake Durability or not.
void	removeAttribute(Attributes.AttributeType type, java.lang.String name, double amount, java.util.UUID uuid, org.bukkit.inventory.EquipmentSlot slot, Attributes.Operation operation) Remove an Attribute from the Custom Item.
void	removeNBTData(java.lang.String nbtKey) Remove NBT Data from the ItemStack.
CustomItemStack	setFakeDurability(int durability) Sets the ItemStack's Current Fake Durability.
CustomItemStack	setTexture(java.lang.String texture) Sets the Texture of the ItemStack.
CustomItemStack	updateLore() Updates the lore of the ItemStack using the CustomItem.getFullLore(Map, int, Attributes) method.
CustomItemStack	updateLore(java.util.Map<org.bukkit.enchantments.Enchantment,java.lang.Integer> enchantsToCheck) Updates the lore of the ItemStack using the CustomItem.getFullLore(Map, int, Attributes) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomItemStack

public CustomItemStack(java.lang.String idName)

Create a new CustomItemStack.
Durability and Texture will be the default values.

Parameters:

idName - The idName of the Custom Item. The Custom Item must be already Initialized using the AdditionsAPIInitializationEvent.

CustomItemStack

public CustomItemStack(java.lang.String idName,
                       short durability,
                       java.lang.String texture)

Create a new CustomItemStack.

Parameters:

idName - The idName of the Custom Item. The Custom Item must be already Initialized using the AdditionsAPIInitializationEvent.

durability - The durability of the ItemStack.

texture - The texture of the ItemStack.

CustomItemStack

public CustomItemStack(CustomItem cItem)

Create a new CustomItemStack.

Parameters:

cItem - The CustomItem that will be used to construct the ItemStack.

CustomItemStack

public CustomItemStack(CustomItem cItem,
                       short durability,
                       java.lang.String texture)

Create a new CustomItemStack.

Parameters:

cItem - The CustomItem that will be used to construct the ItemStack.

durability - The durability of the ItemStack.

texture - The name of the texture of the ItemStack.

CustomItemStack

public CustomItemStack(org.bukkit.inventory.ItemStack item)

Create a new CustomItemStack.

Parameters:

item - The ItemStack that will be used to find the CustomItem, durability and texture.

Method Detail

getCustomItem

public CustomItem getCustomItem()

Returns:

The CustomItem that is contained in the CustomItemStack.

getTexture

public java.lang.String getTexture()

Returns:

The texture of the Custom Item. If the Custom Item does not implement ModelInjector (in other words, it's not a CustomTexturedItem or similar and does not contain a Texture) it will return null.

setTexture

public CustomItemStack setTexture(java.lang.String texture)

Sets the Texture of the ItemStack. This is only applicable for CustomItems that implement ModelInjector and have the Texture already Initialized with the AdditionsAPIInitializationEvent.
When the Texture is set, the ItemStack's durability is changed according to the data file.

Parameters:

texture - The name of the Texture.

getItemStack

public org.bukkit.inventory.ItemStack getItemStack()

Returns:

The ItemStack that the CustomItemStack contains.

getFakeDurability

public int getFakeDurability()

Returns:

The Fake Durability of the ItemStack. This is only valid if the CustomItem has Fake Durability. If it does not, it will return 0.

getMaxFakeDurability

public int getMaxFakeDurability()

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.

setFakeDurability

public CustomItemStack setFakeDurability(int durability)

Sets the ItemStack's Current Fake Durability. This is only valid of the CustomItem has Fake Durability.

Parameters:

durability - The durability to set.

reduceDurability

public CustomItemStack reduceDurability(org.bukkit.entity.Player player,
                                        int durabilityToReduce)

Reduces the durability of the CustomItemStack, whether it's using Fake Durability or not. It uses the PlayerCustomItemDamageEvent, so it could be cancelled.

Parameters:

durabilityToReduce - The amount of durability that will be reduced

updateLore

public CustomItemStack updateLore()

Updates the lore of the ItemStack using the CustomItem.getFullLore(Map, int, Attributes) method. This is necessary if you added Enchantments and will be done automatically if the Item was enchanted in an enchantment table or had its durability changed.

updateLore

public CustomItemStack updateLore(java.util.Map<org.bukkit.enchantments.Enchantment,java.lang.Integer> enchantsToCheck)

Updates the lore of the ItemStack using the CustomItem.getFullLore(Map, int, Attributes) method. This is necessary if you added Enchantments and will be done automatically if the Item was enchanted in an enchantment table or had its durability changed.

addAttribute

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

Add an attribute to the ItemStack. If there are no already existing Attributes, Attack Speed and Attack Damage will be overriden, so keep that in mind.

Parameters:

type -

name -

amount -

uuid -

slot -

operation -

getAttributes

public Attributes getAttributes()

Returns:

The Attributes of the Custom Item.

removeAttribute

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

Remove an Attribute from the Custom Item.

Parameters:

type -

name -

amount -

uuid -

slot -

operation -

addAllNBTData

public void addAllNBTData(java.util.Map<? extends java.lang.String,? extends java.lang.Object> nbtData)

Add all NBT Data from a Map. The String is the NBT Key, the Object is the data you wish to store. Valid types are: Void, byte, short, int, long, float, double, byte[], int[], String, List and Map.

Parameters:

nbtData -

addNBTData

public void addNBTData(java.lang.String nbtKey,
                       java.lang.Object nbtData)

Add NBT Data. Valid types are: Void, byte, short, int, long, float, double, byte[], int[], String, List and Map.

Parameters:

nbtKey -

nbtData -

getNBTData

public NbtFactory.NbtCompound getNBTData()

Returns:

The NBT Data that the ItemStack contains. They are cloned, just in case there aren't any and empty data would be created, causing problems with stacking.

removeNBTData

public void removeNBTData(java.lang.String nbtKey)

Remove NBT Data from the ItemStack.

Parameters:

nbtKey -

clone

public CustomItemStack clone()

Overrides:

clone in class java.lang.Object