nova.core.recipes.crafting

Interface CraftingRecipe

All Superinterfaces:

Recipe

All Known Implementing Classes:

ShapedCraftingRecipe, ShapelessCraftingRecipe

public interface CraftingRecipe
extends Recipe

Contains a single crafting recipe, no matter its crafting logic.

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.
default java.util.Collection<java.lang.String>	getPossibleItemsInFirstSlot() Gets the possible items for this recipe in the first non-empty recipe slot.
boolean	matches(CraftingGrid craftingGrid) Checks if this crafting recipe matches the content of the given crafting grid.

Method Detail

matches

boolean matches(CraftingGrid craftingGrid)

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

Parameters:

craftingGrid - crafting grid to read from

Returns:

true if a crafting operation would return a valid result

getCraftingResult

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

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

Parameters:

craftingGrid - crafting grid

Returns:

crafting result, empty if the recipe doesn't match

getExampleOutput

java.util.Optional<Item> getExampleOutput()

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

Returns:

example output

consumeItems

void consumeItems(CraftingGrid craftingGrid)

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.

Parameters:

craftingGrid - crafting grid to modify

getPossibleItemsInFirstSlot

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

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.

Returns:

The items