nova.core.recipes.crafting

Class ShapedCraftingRecipe

java.lang.Object

nova.core.recipes.crafting.ShapedCraftingRecipe

All Implemented Interfaces:

CraftingRecipe, Recipe

public class ShapedCraftingRecipe
extends java.lang.Object
implements CraftingRecipe

Contains a single shaped crafting recipe. Can contain custom crafting logic.

Crafting recipes can be specified as a 2-dimensional array of ingredients (with Optional.empty() being used for empty spots) or as a 1-dimensional array of ingredients and a pattern string (lines are separated by -, spaces for empty spots, A-Z for ingredients.

For instance, to define a stick recipe with a pattern string:

new ShapedCraftingRecipe("A - A", ItemIngredient.forDictionary("plankWood"));

Two kinds of recipes can be defined: basic or advanced. Basic recipes always return the same item, while advanced recipes have their output defined by a lambda expression. RecipeFunctions will receive information about the

Constructor Summary

Constructors

Constructor and Description
ShapedCraftingRecipe(ItemFactory output, java.util.Optional<ItemIngredient>[][] ingredients) Defines a basic crafting recipe, using a 2D ingredients array.
ShapedCraftingRecipe(ItemFactory output, java.util.Optional<ItemIngredient>[][] ingredients, boolean mirrored) Defines a basic crafting recipe, using a 2D ingredients array.
ShapedCraftingRecipe(ItemFactory output, RecipeFunction recipeFunction, java.util.Optional<ItemIngredient>[][] ingredients) Defines a basic crafting recipe, using a 2D ingredients array.
ShapedCraftingRecipe(ItemFactory output, RecipeFunction recipeFunction, java.util.Optional<ItemIngredient>[][] ingredients, boolean mirrored) Defines an advanced crafting recipe, using a 2D ingredients array.
ShapedCraftingRecipe(ItemFactory output, RecipeFunction recipeFunction, java.lang.String format, boolean mirrored, ItemIngredient... ingredients) Defines an advanced crafting recipe, using a format string.
ShapedCraftingRecipe(ItemFactory output, RecipeFunction recipeFunction, java.lang.String format, ItemIngredient... ingredients) Defines an advanced crafting recipe, using a format string.
ShapedCraftingRecipe(ItemFactory output, java.lang.String format, boolean mirrored, ItemIngredient... ingredients) Defines a basic structured crafting recipe, possibly mirrored, using a format string.
ShapedCraftingRecipe(ItemFactory output, java.lang.String format, ItemIngredient... ingredients) Defines a basic structured crafting recipe, using a format string.

Method Summary

Modifier and Type	Method and Description
void	consumeItems(CraftingGrid craftingGrid) Consumes items for the crafting of a single item.
java.util.Optional<Item>	getCraftingResult(CraftingGrid craftingGrid) Calculates the crafting result for the given crafting grid.
java.util.Optional<Item>	getExampleOutput() Gets a nominal (example) output for this recipe.
int	getHeight()
ItemIngredient[]	getIngredients()
int[]	getIngredientsX()
int[]	getIngredientsY()
java.util.Collection<java.lang.String>	getPossibleItemsInFirstSlot() Gets the possible items for this recipe in the first non-empty recipe slot.
int	getWidth()
boolean	isMirrored()
boolean	matches(CraftingGrid inventory) Checks if this crafting recipe matches the content of the given crafting grid.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            java.lang.String format,
                            ItemIngredient... ingredients)

Defines a basic structured crafting recipe, using a format string.

Parameters:

output - Output Item of the recipe

format - Format

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            java.lang.String format,
                            boolean mirrored,
                            ItemIngredient... ingredients)

Defines a basic structured crafting recipe, possibly mirrored, using a format string.

Parameters:

output - Output Item of the recipe

format - Format

mirrored - Whether this recipe is mirrored

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            RecipeFunction recipeFunction,
                            java.lang.String format,
                            ItemIngredient... ingredients)

Defines an advanced crafting recipe, using a format string.

Parameters:

output - Nominal output of the recipe

recipeFunction - RecipeFunction

format - Format

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            RecipeFunction recipeFunction,
                            java.lang.String format,
                            boolean mirrored,
                            ItemIngredient... ingredients)

Defines an advanced crafting recipe, using a format string.

Parameters:

output - Nominal output of the recipe

recipeFunction - RecipeFunction

format - Format

mirrored - Whether this recipe is mirrored

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            java.util.Optional<ItemIngredient>[][] ingredients)

Defines a basic crafting recipe, using a 2D ingredients array.

Parameters:

output - Output Item of the recipe

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            java.util.Optional<ItemIngredient>[][] ingredients,
                            boolean mirrored)

Defines a basic crafting recipe, using a 2D ingredients array.

Parameters:

output - Output Item of the recipe

ingredients - ItemIngredients

mirrored - Whether this recipe is mirrored

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            RecipeFunction recipeFunction,
                            java.util.Optional<ItemIngredient>[][] ingredients)

Defines a basic crafting recipe, using a 2D ingredients array.

Parameters:

output - Output Item of the recipe

recipeFunction - RecipeFunction

ingredients - ItemIngredients

ShapedCraftingRecipe

public ShapedCraftingRecipe(ItemFactory output,
                            RecipeFunction recipeFunction,
                            java.util.Optional<ItemIngredient>[][] ingredients,
                            boolean mirrored)

Defines an advanced crafting recipe, using a 2D ingredients array.

Parameters:

output - Nominal output of the recipe

recipeFunction - RecipeFunction

ingredients - ItemIngredients

mirrored - Whether this recipe is mirrored

Method Detail

getWidth

public int getWidth()

getHeight

public int getHeight()

isMirrored

public boolean isMirrored()

getIngredients

public ItemIngredient[] getIngredients()

getIngredientsX

public int[] getIngredientsX()

getIngredientsY

public int[] getIngredientsY()

matches

public boolean matches(CraftingGrid inventory)

Description copied from interface: CraftingRecipe

Checks if this crafting recipe matches the content of the given crafting grid.

Specified by:

matches in interface CraftingRecipe

Parameters:

inventory - crafting grid to read from

Returns:

true if a crafting operation would return a valid result

getCraftingResult

public java.util.Optional<Item> getCraftingResult(CraftingGrid craftingGrid)

Description copied from interface: CraftingRecipe

Calculates the crafting result for the given crafting grid. Does not modify the contents of the crafting grid.

Specified by:

getCraftingResult in interface CraftingRecipe

Parameters:

craftingGrid - crafting grid

Returns:

crafting result, empty if the recipe doesn't match

consumeItems

public void consumeItems(CraftingGrid craftingGrid)

Description copied from interface: CraftingRecipe

Consumes items for the crafting of a single item. Removes items and applies any necessary modifications on the stacks in the given crafting grid, and gives back any items if necessary.

Specified by:

consumeItems in interface CraftingRecipe

Parameters:

craftingGrid - crafting grid to modify

getPossibleItemsInFirstSlot

public java.util.Collection<java.lang.String> getPossibleItemsInFirstSlot()

Description copied from interface: CraftingRecipe

Gets the possible items for this recipe in the first non-empty recipe slot. Used to index recipes and can return empty if the recipe is calculated dynamically.

Specified by:

getPossibleItemsInFirstSlot in interface CraftingRecipe

Returns:

The items

getExampleOutput

public java.util.Optional<Item> getExampleOutput()

Description copied from interface: CraftingRecipe

Gets a nominal (example) output for this recipe. Used in recipe display.

Specified by:

getExampleOutput in interface CraftingRecipe

Returns:

example output