net.risingworld.api.utils

Class Definitions.Recipe

java.lang.Object

net.risingworld.api.utils.Definitions.Recipe

Enclosing class:

Definitions

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

A class representing recipe information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Definitions.Recipe.Ingredient A class representing an ingredient (for a crafting recipe).

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	getAllCategories() Gets all crafting categories.
java.lang.String	getCategory() Gets the recipe category (e.g.
int	getID() Gets the recipe ID.
Definitions.Recipe.Ingredient	getIngredient(int index) Gets a specific ingredient.
int	getIngredientCount() Gets the number of required ingredients.
Definitions.Recipe.Ingredient[]	getIngredients() Gets all required ingredients for this recipe.
Definitions.ItemDefinition	getTargetItemDefinition() Gets the target item definition.
short	getTargetItemID() Gets the target item ID.
java.lang.String	getTargetItemName() Gets the target item name (always lowercase), e.g.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public int getID()

Gets the recipe ID.

Returns:

the recipe ID.

getTargetItemID

public short getTargetItemID()

Gets the target item ID.

Returns:

the target item ID.

See Also:

getTargetItemName(), getTargetItemDefinition()

getTargetItemName

public java.lang.String getTargetItemName()

Gets the target item name (always lowercase), e.g. "pickaxe".

Returns:

the target item name.

See Also:

getTargetItemID(), getTargetItemDefinition()

getTargetItemDefinition

public Definitions.ItemDefinition getTargetItemDefinition()

Gets the target item definition.

Returns:

the target item definition.

See Also:

getTargetItemID(), getTargetItemName()

getIngredients

public Definitions.Recipe.Ingredient[] getIngredients()

Gets all required ingredients for this recipe.

Returns:

all ingredients as an array.

getIngredient

public Definitions.Recipe.Ingredient getIngredient(int index)

Gets a specific ingredient. Make sure to check the max index by calling getIngredientCount(). If the index does not exist, this method returns null.

Parameters:

index - the ingredient index (0 for the first ingredient, 1 for the second ingredient etc).

Returns:

the particular ingredient, or null if this index does not exist.

getIngredientCount

public int getIngredientCount()

Gets the number of required ingredients.

Returns:

the number of ingredients.

getCategory

public java.lang.String getCategory()

Gets the recipe category (e.g. "Tools", "Weapons", "Seatings", "Craftingstations" etc).

Returns:

the recipe category.

getAllCategories

public static java.lang.String[] getAllCategories()

Gets all crafting categories.

Returns:

a String array containing all crafting categories.