nova.core.recipes.ingredient

Interface ItemIngredient

All Known Implementing Classes:

AbstractIngredient, OreItemIngredient, SpecificItemIngredient

public interface ItemIngredient

Contains a single item ingredient. An ingredient can be a specific item, an ore dictionary entry, or anything else that can match against items.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Item>	consumeOnCrafting(Item original, CraftingGrid craftingGrid) Performs any necessary actions when this ingredient is consumed due to crafting a single item.
static ItemIngredient	forBlock(BlockFactory block) Retrieves an ingredient to represent a specific block.
static ItemIngredient	forDictionary(java.lang.String id) Retrieves an ingredient to represent a dictionary entry.
static ItemIngredient	forItem(ItemFactory item) Retrieves an ingredient to represent a specific item.
static ItemIngredient	forItem(java.lang.String itemId) Retrieves an ingredient to represent a specific item.
java.util.Collection<Item>	getExampleItems() Returns a list of example items.
java.util.Collection<java.lang.String>	getPossibleItemIds() Returns a list of all items that could possibly match this ingredient.
java.util.Optional<java.lang.String>	getTag() Returns the ingredient tag.
boolean	isSubsetOf(ItemIngredient ingredient) Checks if this ingredient is a subset of another ingredient.
boolean	matches(Item item) Checks if this ingredient matches the given item.
ItemIngredient	withTag(java.lang.String tag) Sets the ingredient tag.

Method Detail

forBlock

static ItemIngredient forBlock(BlockFactory block)

Retrieves an ingredient to represent a specific block.

Parameters:

block - The block

Returns:

ingredient

forItem

static ItemIngredient forItem(ItemFactory item)

Retrieves an ingredient to represent a specific item.

Parameters:

item - The item

Returns:

ingredient

forItem

static ItemIngredient forItem(java.lang.String itemId)

Retrieves an ingredient to represent a specific item.

Parameters:

itemId - item ID

Returns:

ingredient

forDictionary

static ItemIngredient forDictionary(java.lang.String id)

Retrieves an ingredient to represent a dictionary entry.

Parameters:

id - dictionary entry ID

Returns:

ingredient

getPossibleItemIds

java.util.Collection<java.lang.String> getPossibleItemIds()

Returns a list of all items that could possibly match this ingredient. Should return Optional.empty() if there is no such list.

Returns:

possible items

getExampleItems

java.util.Collection<Item> getExampleItems()

Returns a list of example items. This list could be used to render ingredients when displayed to users.

Returns:

example items

isSubsetOf

boolean isSubsetOf(ItemIngredient ingredient)

Checks if this ingredient is a subset of another ingredient. An ingredient is a subset if all items that match this ingredient also match the other ingredient.

Parameters:

ingredient - The another ingredient

Returns:

Result of the check

matches

boolean matches(Item item)

Checks if this ingredient matches the given item.

Parameters:

item - Item to check

Returns:

Whether the item matches or not

getTag

java.util.Optional<java.lang.String> getTag()

Returns the ingredient tag. Ingredients can be tagged to make them easy to read from recipe functions.

Returns:

ingredient tag

withTag

ItemIngredient withTag(java.lang.String tag)

Sets the ingredient tag. Ingredients can be tagged to make them easy to read from recipe functions.

Parameters:

tag - The ingredient tag

Returns:

this instance

consumeOnCrafting

java.util.Optional<Item> consumeOnCrafting(Item original,
                                           CraftingGrid craftingGrid)

Performs any necessary actions when this ingredient is consumed due to crafting a single item. May return a stack with zero size, but cannot return null.

Parameters:

original - ingredient

craftingGrid - CraftingGrid used

Returns:

Resulting Item, or an empty optional if the item was empty.