net.risingworld.api.utils

Class Definitions.Recipe.Ingredient

java.lang.Object

net.risingworld.api.utils.Definitions.Recipe.Ingredient

Enclosing class:

Definitions.Recipe

public static class Definitions.Recipe.Ingredient
extends java.lang.Object

A class representing an ingredient (for a crafting recipe).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGroup() Gets the ingredient group.
Definitions.ItemDefinition	getRelatedItemDefinition() Gets the related item definition.
short	getRelatedItemID() Gets the related item ID (i.e. the actual ingredient).
java.lang.String	getRelatedItemName() Gets the related item name (always lowercase), e.g.
int	getRelatedItemTextureID() Gets the related item texture.
boolean	isConsumed() Gets whether or not this ingredient will be "consumed" when crafting an item.

Methods inherited from class java.lang.Object

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

Method Detail

getGroup

public java.lang.String getGroup()

Gets the ingredient group. Most ingredients don't have a group, actually only a few ingredients have a group. For example, all treelog items (from the various trees) are in the "treelog" group. Since it doesn't matter which treelog type you have in your inventory when crafting a wooden item, those recipes simply require a "treelog" group ingredient.

Returns:

the ingredient group, or null if this ingredient has no group (which applies to most items/ingredients)

getRelatedItemID

public short getRelatedItemID()

Gets the related item ID (i.e. the actual ingredient).

Returns:

the related item ID.

See Also:

getRelatedItemName(), getRelatedItemDefinition()

getRelatedItemTextureID

public int getRelatedItemTextureID()

Gets the related item texture. Most ingredients don't have a specific texture ID (i.e. this returns 0, which is the default texture ID), but especially ores make use of the texture ID (since there is just a single "ore" item in the game, and the ore type is only determined via the texture ID.

Returns:

the texture ID (most ingredients use the default texture ID, i.e. 0)

getRelatedItemName

public java.lang.String getRelatedItemName()

Gets the related item name (always lowercase), e.g. "lumber".

Returns:

the related item name.

See Also:

getRelatedItemID(), getRelatedItemDefinition()

getRelatedItemDefinition

public Definitions.ItemDefinition getRelatedItemDefinition()

Gets the related item definition.

Returns:

the related item definition.

See Also:

getRelatedItemID(), getRelatedItemName()

isConsumed

public boolean isConsumed()

Gets whether or not this ingredient will be "consumed" when crafting an item. This applies to most items, but there are a few items (for example tools) which only serve as an additional requirement for a crafting recipe (so it does not get consumed).

Returns:

true if this ingredient will be consumed when crafting an item, false if not.