net.risingworld.api.objects

Interface Item

All Known Subinterfaces:

WorldItem

public interface Item

Represents an item that exists in the inventory of a player or in a chest.
Please note that this item does not really exists in the game world.

See Also:

WorldItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Item.Attribute Attributes are used for all items which require additional information.
static interface	Item.ClothingAttribute This attribute is used for all clothing items.
static interface	Item.CustomItemAttribute This attribute is used for custom items, i.e. items which were added through the API.
static class	Item.Definition Deprecated. Use Definitions.ItemDefinition instead!
static interface	Item.ObjectAttribute This attribute is used for all items which represent an object (e.g. furniture).

Method Summary

Modifier and Type	Method and Description
Item.Attribute	getAttribute() Gets the item attribute.
Definitions.ItemDefinition	getDefinition() Gets the item definition of this item.
static Item.Definition	getItemDefinition(short typeID) Deprecated. Use Definitions.getItemDefinition(short) instead!
static Item.Definition	getItemDefinition(java.lang.String name) Deprecated. Use Definitions.getItemDefinition(String) instead!
int	getMaxStacksize() Gets the max stack size of the item.
java.lang.String	getName() Gets the ingame name (not the localized name) of the item.
int	getStacksize() Gets the current stack size of the item.
int	getStatus() Gets the current status of the item.
short	getTypeID() Gets the type ID of the item.
float	getValue() Gets the current value of the item.
int	getVariation() Gets the variation, i.e. the texture of the item.

Method Detail

getName

java.lang.String getName()

Gets the ingame name (not the localized name) of the item.

Returns:

the name of the item.

getTypeID

short getTypeID()

Gets the type ID of the item.

Returns:

the type ID of the item.

getVariation

int getVariation()

Gets the variation, i.e. the texture of the item. This is only relevant for blocks or construction elements.

Returns:

the variation/texture of the item. Usually this function returns 0 for most regular items.

getStacksize

int getStacksize()

Gets the current stack size of the item.

Returns:

the stack size of the item.

getMaxStacksize

int getMaxStacksize()

Gets the max stack size of the item.

Returns:

the max stack size of the item (between 1 and 64).

getValue

float getValue()

Gets the current value of the item. Usually the value is used to describe a "fill level" or "charging level", for example it describes how much water is in a bottle.

Returns:

the value of the item.

getStatus

int getStatus()

Gets the current status of the item. The status is used to store additional information about an item (for example the water type in a bucket, or if an electronic device is switched on/off).

Returns:

the status of the item.

getDefinition

Definitions.ItemDefinition getDefinition()

Gets the item definition of this item.

Returns:

the definition of this item.

getAttribute

Item.Attribute getAttribute()

Gets the item attribute. Only certain items have an attribute, e.g. objects or clothing items. These attributes contain additional information (e.g. object id, clothing id etc). Most items don't have an attribute and return null.

Returns:

the item attribute (if it has an attribute), or null if there is no item attribute available.

getItemDefinition

static Item.Definition getItemDefinition(short typeID)

Deprecated. Use Definitions.getItemDefinition(short) instead!

Parameters:

typeID - item type id.

Returns:

---

getItemDefinition

static Item.Definition getItemDefinition(java.lang.String name)

Deprecated. Use Definitions.getItemDefinition(String) instead!

Parameters:

name - item name.

Returns:

---