Package org.bukkit.inventory

Class ShapedRecipe

java.lang.Object

org.bukkit.inventory.CraftingRecipe

org.bukkit.inventory.ShapedRecipe

All Implemented Interfaces:

Keyed, Recipe, Keyed

public class ShapedRecipe
extends CraftingRecipe

Represents a shaped (ie normal) crafting recipe.

Constructor Summary

Constructors

Constructor	Description
ShapedRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result)	Create a shaped recipe to craft the specified ItemStack.
ShapedRecipe(@NotNull ItemStack result)	Deprecated. Recipes must have keys.

Method Summary

Modifier and Type	Method	Description
@NotNull Map<Character,RecipeChoice>	getChoiceMap()	Get a copy of the choice map.
@NotNull Map<Character,ItemStack>	getIngredientMap()	Deprecated. Use getChoiceMap() instead for more complete data.
@NotNull String[]	getShape()	Get the shape.
@NotNull ShapedRecipe	setIngredient(char key, @NotNull Material ingredient)	Sets the material that a character in the recipe shape refers to.
@NotNull ShapedRecipe	setIngredient(char key, @NotNull Material ingredient, int raw)	Deprecated. Magic value
@NotNull ShapedRecipe	setIngredient(char key, @NotNull ItemStack item)
@NotNull ShapedRecipe	setIngredient(char key, @NotNull RecipeChoice ingredient)	Sets the RecipeChoice that a character in the recipe shape refers to.
@NotNull ShapedRecipe	setIngredient(char key, @NotNull MaterialData ingredient)	Deprecated. use setIngredient(char, RecipeChoice)
@NotNull ShapedRecipe	shape(@NotNull String... shape)	Set the shape of this recipe to the specified rows.

Methods inherited from class org.bukkit.inventory.CraftingRecipe

checkResult, getCategory, getGroup, getKey, getResult, setCategory, setGroup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.Keyed

key

Constructor Details

ShapedRecipe

@Deprecated
public ShapedRecipe(@NotNull
 @NotNull ItemStack result)

Deprecated.

Recipes must have keys. Use ShapedRecipe(NamespacedKey, ItemStack) instead.

Create a shaped recipe to craft the specified ItemStack. The constructor merely determines the result and type; to set the actual recipe, you'll need to call the appropriate methods.

Parameters:

result - The item you want the recipe to create.

See Also:

• shape(String...)
• setIngredient(char, Material)
• setIngredient(char, RecipeChoice)

ShapedRecipe

public ShapedRecipe(@NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull ItemStack result)

Create a shaped recipe to craft the specified ItemStack. The constructor merely determines the result and type; to set the actual recipe, you'll need to call the appropriate methods.

Parameters:

key - the unique recipe key

result - The item you want the recipe to create.

Throws:

IllegalArgumentException - if the result is an empty item (AIR)

See Also:

• shape(String...)
• setIngredient(char, Material)
• setIngredient(char, RecipeChoice)

Method Details

shape

@NotNull
public @NotNull ShapedRecipe shape(@NotNull
 @NotNull String... shape)

Set the shape of this recipe to the specified rows. Each character represents a different ingredient; excluding space characters, which must be empty, exactly what each character represents is set separately. The first row supplied corresponds with the upper most part of the recipe on the workbench e.g. if all three rows are supplies the first string represents the top row on the workbench.

Parameters:

shape - The rows of the recipe (up to 3 rows).

Returns:

The changed recipe, so you can chain calls.

setIngredient

@NotNull
@Deprecated
public @NotNull ShapedRecipe setIngredient(char key,
 @NotNull
 @NotNull MaterialData ingredient)

Deprecated.

use setIngredient(char, RecipeChoice)

Sets the material that a character in the recipe shape refers to.

Note that before an ingredient can be set, the recipe's shape must be defined with shape(String...).

Parameters:

key - The character that represents the ingredient in the shape.

ingredient - The ingredient.

Returns:

The changed recipe, so you can chain calls.

Throws:

IllegalArgumentException - if the key is a space character

IllegalArgumentException - if the key does not appear in the shape.

setIngredient

@NotNull
public @NotNull ShapedRecipe setIngredient(char key,
 @NotNull
 @NotNull Material ingredient)

Sets the material that a character in the recipe shape refers to.

Note that before an ingredient can be set, the recipe's shape must be defined with shape(String...).

Parameters:

key - The character that represents the ingredient in the shape.

ingredient - The ingredient.

Returns:

The changed recipe, so you can chain calls.

Throws:

IllegalArgumentException - if the key is a space character

IllegalArgumentException - if the key does not appear in the shape.

setIngredient

@Deprecated
@NotNull
public @NotNull ShapedRecipe setIngredient(char key,
 @NotNull
 @NotNull Material ingredient,
 int raw)

Deprecated.

Magic value

Sets the material that a character in the recipe shape refers to.

Note that before an ingredient can be set, the recipe's shape must be defined with shape(String...).

Parameters:

key - The character that represents the ingredient in the shape.

ingredient - The ingredient.

raw - The raw material data as an integer.

Returns:

The changed recipe, so you can chain calls.

Throws:

IllegalArgumentException - if the key is a space character

IllegalArgumentException - if the key does not appear in the shape.

setIngredient

@NotNull
public @NotNull ShapedRecipe setIngredient(char key,
 @NotNull
 @NotNull RecipeChoice ingredient)

Sets the RecipeChoice that a character in the recipe shape refers to.

Note that before an ingredient can be set, the recipe's shape must be defined with shape(String...).

Parameters:

key - The character that represents the ingredient in the shape.

ingredient - The ingredient.

Returns:

The changed recipe, so you can chain calls.

Throws:

IllegalArgumentException - if the key is a space character

IllegalArgumentException - if the key does not appear in the shape.

setIngredient

@NotNull
public @NotNull ShapedRecipe setIngredient(char key,
 @NotNull
 @NotNull ItemStack item)

getIngredientMap

@Deprecated
@NotNull
public @NotNull Map<Character,ItemStack> getIngredientMap()

Deprecated.

Use getChoiceMap() instead for more complete data.

Get a copy of the ingredients map.

Returns:

The mapping of character to ingredients.

getChoiceMap

@NotNull
public @NotNull Map<Character,RecipeChoice> getChoiceMap()

Get a copy of the choice map.

Returns:

The mapping of character to ingredients.

getShape

@NotNull
public @NotNull String[] getShape()

Get the shape.

Returns:

The recipe's shape.

Throws:

NullPointerException - when not set yet