com.chrismin13.additionsapi.items

Class StorageCustomItem

java.lang.Object

com.chrismin13.additionsapi.items.StorageCustomItem

public class StorageCustomItem
extends java.lang.Object

Used for Converting the Objects saved in the data.yml file. Meant mostly for internal use in the API. In order to obtain one, use the methods is DataFile

Author:

chrismin13

Constructor Summary

Constructors

Constructor and Description
StorageCustomItem(org.bukkit.Material material, short durability) Create a new StorageCustomItem.
StorageCustomItem(org.bukkit.Material material, short durability, java.lang.String idName, java.lang.String texture) Create a new StorageCustomItem.
StorageCustomItem(StorageCustomItem sItem) Create a new StorageCustomItem from another StorageCustomItem.
StorageCustomItem(java.lang.String idName, java.lang.String texture) Create a new StorageCustomItem.

Method Summary

Modifier and Type	Method and Description
CustomItem	getCustomItem()
CustomItemStack	getCustomItemStack()
short	getDurability()
java.lang.String	getIdName()
org.bukkit.Material	getMaterial()
java.lang.String	getTexture()
StorageCustomItem	setDurability(short durability) Set the StorageCustomItem's Durability Value.
StorageCustomItem	setIdName(java.lang.String idName) Set the result CustomItem's ID Name.
StorageCustomItem	setMaterial(org.bukkit.Material material) Set the Material of the StorageCustomItem.
StorageCustomItem	setTexture(java.lang.String texture) Set the name of the texture that is a ssigned to this StorageCustomItem's durability point.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageCustomItem

public StorageCustomItem(org.bukkit.Material material,
                         short durability,
                         java.lang.String idName,
                         java.lang.String texture)

Create a new StorageCustomItem. This is just a Java Object and won't be saved to the Data.yml file. For that, use the methods at DataFile.

Parameters:

material - The Material of the StorageCustomItem.

durability - The Durability Value of the StorageCustomItem

idName - The ID Name of the StorageCustomItem

texture - The Texture Name of the StorageCustomItem

StorageCustomItem

public StorageCustomItem(org.bukkit.Material material,
                         short durability)

Create a new StorageCustomItem. The values for the ID Name and Texture Name will be generated form the values of the data.yml file

Parameters:

material - The Material of the StorageCustomItem.

durability - The Durability Value of the StorageCustomItem

StorageCustomItem

public StorageCustomItem(java.lang.String idName,
                         java.lang.String texture)

Create a new StorageCustomItem. The values for the Material and Durability will be generated form the values of the data.yml file

Parameters:

idName - The ID Name of the StorageCustomItem

texture - The Texture Name of the StorageCustomItem

StorageCustomItem

public StorageCustomItem(StorageCustomItem sItem)

Create a new StorageCustomItem from another StorageCustomItem. The values of the object specified won't be cloned, they will be the same.

Parameters:

sItem - The StorageCustomItem to clone.

Method Detail

getMaterial

public org.bukkit.Material getMaterial()

Returns:

The Material of the StorageCustomItem

setMaterial

public StorageCustomItem setMaterial(org.bukkit.Material material)

Set the Material of the StorageCustomItem.

Parameters:

material -

getDurability

public short getDurability()

Returns:

The StorageCustomItem's Durability Value. This is not fake durability - it's what durability the item given to the player will actually have. This is very important for CustomTexturedItems where the durability is not predetermined, but instead defined upon server startup.

setDurability

public StorageCustomItem setDurability(short durability)

Set the StorageCustomItem's Durability Value. This is not fake durability - it's what durability the item given to the player will actually have. This is very important for CustomTexturedItems where the durability is not predetermined, but instead defined upon server startup.

Parameters:

durability -

getIdName

public java.lang.String getIdName()

Returns:

The result CustomItem's ID Name.

setIdName

public StorageCustomItem setIdName(java.lang.String idName)

Set the result CustomItem's ID Name.

Parameters:

idName -

getTexture

public java.lang.String getTexture()

Returns:

The name of the texture that is assigned to this StorageCustomItem's durability point.

setTexture

public StorageCustomItem setTexture(java.lang.String texture)

Set the name of the texture that is a ssigned to this StorageCustomItem's durability point.

Parameters:

texture -

getCustomItemStack

public CustomItemStack getCustomItemStack()

Returns:

Get a CustomItemStack with this StorageCustomItem's IdName, Durability and Texture Name.

getCustomItem

public CustomItem getCustomItem()

Returns:

Get a CustomItem with this StorageCustomItem's IdName, Durability and Texture Name.