net.risingworld.api.objects.custom

Class CustomRecipe

java.lang.Object

net.risingworld.api.objects.custom.CustomRecipe

public class CustomRecipe
extends java.lang.Object

Creates a custom item recipe. Currently this only works for CustomItems. Adding a custom recipe enables the player to craft the target item.

See Also:

Server.registerCustomRecipe(net.risingworld.api.objects.custom.CustomRecipe)

Example: Register a custom recipe (MAKE SURE TO REGISTER THE CUSTOM ITEM FIRST)

1	//Define a new custom recipe (use the UUID of your custom item)
2	CustomRecipe recipe = new CustomRecipe("uuid", CustomRecipe.Type.CustomItem, 0, "cooking1", "workbench");
3
4	//Define the required ingredients
5	recipe.setIngredients("8x lumber", "4x ironplate");
6
7	//Set localized names. If you don't want multi language support, just provide a single universal name
8	recipe.setLocalizedNames("Blender");
9
10	//Set a localized category name
11	recipe.setLocalizedCategories("Kitchen Gadgets");
12
13	//Set a localized description
14	recipe.setLocalizedDescriptions("Will it blend?");
15
16	//Define the amount of items you get when crafting this recipe
17	recipe.setTargetCount(1);
18
19	//Once everything is set up for the recipe, register it with the server
20	getServer().registerCustomRecipe(recipe);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomRecipe.Type

Constructor Summary

Constructors

Constructor and Description
CustomRecipe(java.lang.String uuid, CustomRecipe.Type type, int variation, java.lang.String category, java.lang.String... craftingStations) Creates a new custom recipe.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory()
java.lang.String[]	getCraftingStations()
java.lang.String[]	getIngredients() Gets all ingredients which are required to craft this item.
java.lang.String[]	getLocalizedCategories()
java.lang.String[]	getLocalizedDescriptions()
java.lang.String[]	getLocalizedNames()
Vector3f	getPreviewOffset()
Quaternion	getPreviewRotation()
float	getPreviewSize() Gets the size of the preview element (in the crafting menu).
int	getTargetCount() Gets the amount of items you get when crafting this item.
java.lang.String	getTargetUUID() Gets the UUID of the target item/object.
int	getTargetVariation() Gets the variation of the target item/object.
void	setIngredients(java.lang.String... ingredients) Sets the ingredients which are required to craft this item.
void	setLocalizedCategories(java.lang.String... categoryNames) Sets a (localized) name for the category.
void	setLocalizedDescriptions(java.lang.String... descriptions)
void	setLocalizedNames(java.lang.String... names) Sets a (localized) name of the recipe.
void	setPreviewOffset(float x, float y, float z)
void	setPreviewOffset(Vector3f offset)
void	setPreviewRotation(float x, float y, float z, float w)
void	setPreviewRotation(Quaternion rotation)
void	setPreviewSize(float size) Sets the size of the preview 3D view.
void	setTargetCount(int count) Sets the amount of items you get when crafting this item.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomRecipe

public CustomRecipe(java.lang.String uuid,
                    CustomRecipe.Type type,
                    int variation,
                    java.lang.String category,
                    java.lang.String... craftingStations)

Creates a new custom recipe. After registering this recipe to the server (see Server.registerCustomRecipe(net.risingworld.api.objects.custom.CustomRecipe)), players will be able to craft the item at the specified crafting station(s).

Parameters:

uuid - the UUID of the custom item.

type - the recipe type.

variation - the target variation of the item. Default is 0

category - the item category (where the item is listed). You can either specify a new category, or alternatively you can use an existing one (e.g. "tools"). Use lower-case names (the specified category is only used as internal identifier). For the actual category name (which is shown to the player), you can use setLocalizedCategories(java.lang.String...) (for example, you could use "oldweapons" as category name, and specify "Historic Melee Weapons" as localized name).

craftingStations - the crafting stations where the item can be crafted. Always use lower-case names. Examples: "player" (default crafting menu, accessible from the inventory), "workbench" (first workbench), "sawmill" (saw bench), "workbench2" (workbench tier II) etc.

Method Detail

setTargetCount

public void setTargetCount(int count)

Sets the amount of items you get when crafting this item. Default is 1.

Parameters:

count - the new amount of items you get when crafting this item.

getTargetCount

public int getTargetCount()

Gets the amount of items you get when crafting this item. Default is 1.

Returns:

the amount of items you get when crafting this item.

getTargetVariation

public int getTargetVariation()

Gets the variation of the target item/object. By default 0.

Returns:

the target item/object variation.

getTargetUUID

public java.lang.String getTargetUUID()

Gets the UUID of the target item/object.

Returns:

the target item/object UUID.

getCategory

public java.lang.String getCategory()

setLocalizedNames

public void setLocalizedNames(java.lang.String... names)

Sets a (localized) name of the recipe. This is the name which is actually shown in the crafting menu. Currently supported languages: en (english), de (german)

Parameters:

names - an array of all localized names for this item. If you want to support multiple languages, you have set the name like this: "en=Pickaxe" or "de=Spitzhacke" etc. If you want to use a single, universal name for the item, just provide it without any language indicators, i.e. "Pickaxe"

getLocalizedNames

public java.lang.String[] getLocalizedNames()

setLocalizedDescriptions

public void setLocalizedDescriptions(java.lang.String... descriptions)

getLocalizedDescriptions

public java.lang.String[] getLocalizedDescriptions()

getCraftingStations

public java.lang.String[] getCraftingStations()

setLocalizedCategories

public void setLocalizedCategories(java.lang.String... categoryNames)

Sets a (localized) name for the category. This is the name which is actually shown in the crafting menu. It's possible to specify multiple localized names. Currently supported languages: en (english), de (german)
Note: This only works if you use a custom category name. When using a default category name (which is already used by the game), the localized names will be ignored.

Parameters:

categoryNames - an array of all localized category names for this recipe. If you want to support multiple languages, you have set the name like this: "en=Magic Weapons" or "de=Magische Waffen" etc. If you want to use a single, universal name for the item, just provide it without any language indicators, i.e. "Magic Weapons"

getLocalizedCategories

public java.lang.String[] getLocalizedCategories()

setIngredients

public void setIngredients(java.lang.String... ingredients)

Sets the ingredients which are required to craft this item. Provide the ingredients as an array of strings, containing the amount, e.g. "4x lumber", "8x ironingot" etc.
If you want to set an item group, use "g(group)", e.g. "1x g(treelog)". If you want to set ingredients which will not be consumed (e.g. a certain tool), just provide the name of the item, e.g. "huntingknife". Set to null if you want the item to be craftable for free.

Parameters:

ingredients - the ingredients, as an array of strings.

Example: Set ingredients: 4x copper ingot, 2x lumber, 2x coal, 2x treelog

1	CustomRecipe recipe = new CustomRecipe(...);
2	recipe.setIngredients("4x copperingot", "2x lumber", "2x ore(15)", "2x g(treelog)");

getIngredients

public java.lang.String[] getIngredients()

Gets all ingredients which are required to craft this item.

Returns:

an array of strings containing all ingredients. Returns null if the item can be crafted for free.

setPreviewSize

public void setPreviewSize(float size)

Sets the size of the preview 3D view.

Parameters:

size - the size of the preview model. Default is 1.0f

getPreviewSize

public float getPreviewSize()

Gets the size of the preview element (in the crafting menu).

Returns:

the preview size. Default is 1.0f

setPreviewOffset

public void setPreviewOffset(Vector3f offset)

setPreviewOffset

public void setPreviewOffset(float x,
                             float y,
                             float z)

setPreviewRotation

public void setPreviewRotation(Quaternion rotation)

setPreviewRotation

public void setPreviewRotation(float x,
                               float y,
                               float z,
                               float w)

getPreviewOffset

public Vector3f getPreviewOffset()

getPreviewRotation

public Quaternion getPreviewRotation()