Package cn.nukkit.inventory

Class ShapedRecipe

java.lang.Object

cn.nukkit.inventory.ShapedRecipe

All Implemented Interfaces:

CraftingRecipe, Recipe

public class ShapedRecipe
extends Object
implements CraftingRecipe

Author:

MagicDroidX (Nukkit Project)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShapedRecipe.Entry

Constructor Summary

Constructors

Constructor	Description
ShapedRecipe(Item primaryResult, String[] shape, Map<Character,Item> ingredients, List<Item> extraResults)
ShapedRecipe(String recipeId, int priority, Item primaryResult, String[] shape, Map<Character,ItemDescriptor> ingredients, Collection<Item> extraResults)
ShapedRecipe(String recipeId, int priority, Item primaryResult, String[] shape, Map<Character,Item> ingredients, List<Item> extraResults)	Constructs a ShapedRecipe instance.

Method Summary

Modifier and Type	Method	Description
List<Item>	getAllResults()
List<Item>	getExtraResults()
int	getHeight()
UUID	getId()
Item	getIngredient(int x, int y)	Deprecated.
List<Item>	getIngredientList()	Deprecated.
Map<Integer,Map<Integer,Item>>	getIngredientMap()
List<Item>	getIngredientsAggregate()
ItemDescriptor	getNewIngredient(int x, int y)
List<ItemDescriptor>	getNewIngredientList()
int	getPriority()
String	getRecipeId()
Item	getResult()
String[]	getShape()
RecipeType	getType()
int	getWidth()
boolean	matchItems(List<Item> inputList, List<Item> extraOutputList)	Returns whether the specified list of crafting grid inputs and outputs matches this recipe.
boolean	matchItems(List<Item> inputList, List<Item> extraOutputList, int multiplier)
void	registerToCraftingManager(CraftingManager manager)
boolean	requiresCraftingTable()
void	setId(UUID uuid)
ShapedRecipe	setIngredient(char key, ItemDescriptor item)
ShapedRecipe	setIngredient(char key, Item item)
ShapedRecipe	setIngredient(String key, Item item)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ShapedRecipe

public ShapedRecipe(Item primaryResult,
 String[] shape,
 Map<Character,Item> ingredients,
 List<Item> extraResults)

ShapedRecipe

public ShapedRecipe(String recipeId,
 int priority,
 Item primaryResult,
 String[] shape,
 Map<Character,Item> ingredients,
 List<Item> extraResults)

Constructs a ShapedRecipe instance.

Parameters:

primaryResult - Primary result of the recipe

shape -
Array of 1, 2, or 3 strings representing the rows of the recipe. This accepts an array of 1, 2 or 3 strings. Each string should be of the same length and must be at most 3 characters long. Each character represents a unique type of ingredient. Spaces are interpreted as air.

ingredients -
Char => Item map of items to be set into the shape. This accepts an array of Items, indexed by character. Every unique character (except space) in the shape array MUST have a corresponding item in this list. Space character is automatically treated as air.

extraResults -
List of additional result items to leave in the crafting grid afterwards. Used for things like cake recipe empty buckets.

Note: Recipes **do not** need to be square. Do NOT add padding for empty rows/columns.

ShapedRecipe

public ShapedRecipe(String recipeId,
 int priority,
 Item primaryResult,
 String[] shape,
 Map<Character,ItemDescriptor> ingredients,
 Collection<Item> extraResults)

Method Details

getWidth

public int getWidth()

getHeight

public int getHeight()

getResult

public Item getResult()

Specified by:

getResult in interface Recipe

getRecipeId

public String getRecipeId()

Specified by:

getRecipeId in interface Recipe

getId

public UUID getId()

Specified by:

getId in interface CraftingRecipe

setId

public void setId(UUID uuid)

Specified by:

setId in interface CraftingRecipe

setIngredient

public ShapedRecipe setIngredient(String key,
 Item item)

setIngredient

public ShapedRecipe setIngredient(char key,
 Item item)

setIngredient

@PowerNukkitXOnly
@Since("1.19.50-r2")
public ShapedRecipe setIngredient(char key,
 ItemDescriptor item)

getIngredientList

@Deprecated
@DeprecationDetails(since="1.19.50-r2",
                    reason="new ingredients format",
                    replaceWith="use getNewIngredientList()")
public List<Item> getIngredientList()

Deprecated.

getNewIngredientList

@PowerNukkitXOnly
@Since("1.19.50-r2")
public List<ItemDescriptor> getNewIngredientList()

getIngredientMap

public Map<Integer,Map<Integer,Item>> getIngredientMap()

getIngredient

@Deprecated
@DeprecationDetails(since="1.19.50-r2",
                    reason="new ingredients format",
                    replaceWith="use getNewIngredient()")
public Item getIngredient(int x,
 int y)

Deprecated.

getNewIngredient

@PowerNukkitXOnly
@Since("1.19.50-r2")
public ItemDescriptor getNewIngredient(int x,
 int y)

getShape

public String[] getShape()

registerToCraftingManager

public void registerToCraftingManager(CraftingManager manager)

Specified by:

registerToCraftingManager in interface Recipe

getType

public RecipeType getType()

Specified by:

getType in interface Recipe

getExtraResults

public List<Item> getExtraResults()

Specified by:

getExtraResults in interface CraftingRecipe

getAllResults

public List<Item> getAllResults()

Specified by:

getAllResults in interface CraftingRecipe

getPriority

public int getPriority()

Specified by:

getPriority in interface CraftingRecipe

matchItems

public boolean matchItems(List<Item> inputList,
 List<Item> extraOutputList,
 int multiplier)

Specified by:

matchItems in interface CraftingRecipe

matchItems

public boolean matchItems(List<Item> inputList,
 List<Item> extraOutputList)

Returns whether the specified list of crafting grid inputs and outputs matches this recipe. Outputs DO NOT include the primary result item.

Specified by:

matchItems in interface CraftingRecipe

Parameters:

inputList - list of items taken from the crafting grid

extraOutputList - list of items put back into the crafting grid (secondary results)

Returns:

bool

toString

public String toString()

Overrides:

toString in class Object

requiresCraftingTable

public boolean requiresCraftingTable()

Specified by:

requiresCraftingTable in interface CraftingRecipe

getIngredientsAggregate

public List<Item> getIngredientsAggregate()

Specified by:

getIngredientsAggregate in interface CraftingRecipe