net.risingworld.api.utils

Class Definitions.ItemDefinition

java.lang.Object

net.risingworld.api.utils.Definitions.ItemDefinition

Enclosing class:

Definitions

public static class Definitions.ItemDefinition
extends java.lang.Object

A class representing item definitions ("meta data").

Method Summary

Modifier and Type	Method and Description
short	getID() Gets the ID.
int	getMaxStacksize() Gets the max stack size of the item.
java.lang.String	getName() Gets the item name (alway lowercase).
int	getStrength() Gets the strength of this item (determines how many hits it can take until it breaks).
java.lang.String	getType() Gets the item type as String (always uppercase), for example "BLOCK".
int	getVariationCount() Gets the amount of available variations for this item.
boolean	isAmmoItem() Gets whether or not this is an ammo item.
boolean	isArmorItem() Deprecated. This attribute is no longer used for items!
boolean	isEquipmentItem() Gets whether or not this is an equipment item.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public short getID()

Gets the ID.

Returns:

the item ID.

getName

public java.lang.String getName()

Gets the item name (alway lowercase). This is the same name that is used for console commands (e.g. "pickaxe").

Returns:

the item name.

getType

public java.lang.String getType()

Gets the item type as String (always uppercase), for example "BLOCK". Valid item types: DEFAULT, BLOCK, ORE, OBJECT, CONSTRUCTION, PLANT, MUSICRECORD, NPC

Returns:

the item type as String.

isEquipmentItem

public boolean isEquipmentItem()

Gets whether or not this is an equipment item.

Returns:

true if this is an equipment item (i.e. you can put it into the equipment slots of the inventory), false if not.

isAmmoItem

public boolean isAmmoItem()

Gets whether or not this is an ammo item.

Returns:

true if this is an ammo item (i.e. you can put it into the ammo slots of the inventory), false if not.

isArmorItem

public boolean isArmorItem()

Deprecated. This attribute is no longer used for items!

Returns:

always false. Do not use.

getStrength

public int getStrength()

Gets the strength of this item (determines how many hits it can take until it breaks).

Returns:

the item strength.

getMaxStacksize

public int getMaxStacksize()

Gets the max stack size of the item.

Returns:

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

getVariationCount

public int getVariationCount()

Gets the amount of available variations for this item.

Returns:

the amount of available item variations.