Package org.spongepowered.api.item.recipe.crafting

Interface Ingredient

All Superinterfaces:

java.util.function.Predicate<ItemStack>

public interface Ingredient
extends java.util.function.Predicate<ItemStack>

An Ingredient for a crafting recipe.

Crafting recipes can only be crafted when all of the ingredients match the items in the input grid.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Ingredient.Builder	Builder for Ingredients.
static interface	Ingredient.Factory

Method Summary

Modifier and Type	Method	Description
static Ingredient.Builder	builder()	Creates a new Ingredient.Builder to build an Ingredient.
java.util.List<ItemStackSnapshot>	displayedItems()	Returns the list of ItemStacks used to display the ingredient in a recipe.
static Ingredient	empty()	An empty ingredient.
static Ingredient	of(@Nullable ItemStack... items)	Creates a new Ingredient for the provided ItemStacks.
static Ingredient	of(@Nullable ItemStackSnapshot... items)	Creates a new Ingredient for the provided ItemStackSnapshots.
static Ingredient	of(@Nullable ItemType... itemTypes)	Creates a new Ingredient for the provided ItemTypes.
static Ingredient	of(@Nullable DefaultedRegistryReference<? extends ItemType>... itemTypes)	Creates a new Ingredient for the provided ItemTypes.
static Ingredient	of(ResourceKey key)	Creates a new Ingredient for the provided key which should match an item.
static Ingredient	of(ResourceKey key, java.util.function.Predicate<ItemStack> predicate, ItemStack... exemplaryStacks)	Creates a new Ingredient for the provided Predicate and exemplary ItemStacks.
boolean	test(ItemStack itemStack)

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Detail

empty

static Ingredient empty()

An empty ingredient.

Returns:

The empty ingredient

test

boolean test(ItemStack itemStack)

Specified by:

test in interface java.util.function.Predicate<ItemStack>

displayedItems

java.util.List<ItemStackSnapshot> displayedItems()

Returns the list of ItemStacks used to display the ingredient in a recipe. These are not necessarily all the items that this Ingredient can match.

Returns:

The list of items to display the Ingredient in a recipe.

builder

static Ingredient.Builder builder()

Creates a new Ingredient.Builder to build an Ingredient.

Returns:

The new builder

of

static Ingredient of(@Nullable ItemType... itemTypes)

Creates a new Ingredient for the provided ItemTypes.

Parameters:

itemTypes - The items

Returns:

The new ingredient

of

static Ingredient of(@Nullable ItemStack... items)

Creates a new Ingredient for the provided ItemStacks.

Parameters:

items - The items

Returns:

The new ingredient

of

static Ingredient of(@Nullable ItemStackSnapshot... items)

Creates a new Ingredient for the provided ItemStackSnapshots.

Parameters:

items - The item

Returns:

The new ingredient

of

@SafeVarargs
static Ingredient of(@Nullable DefaultedRegistryReference<? extends ItemType>... itemTypes)

Creates a new Ingredient for the provided ItemTypes.

Parameters:

itemTypes - The items

Returns:

The new ingredient

of

static Ingredient of(ResourceKey key,
                     java.util.function.Predicate<ItemStack> predicate,
                     ItemStack... exemplaryStacks)

Creates a new Ingredient for the provided Predicate and exemplary ItemStacks.

Note: Predicate ingredients may not be fully supported for all recipe types

Parameters:

key - A unique resource key

predicate - The predicate

exemplaryStacks - The exemplary items

Returns:

The new ingredient

of

static Ingredient of(ResourceKey key)

Creates a new Ingredient for the provided key which should match an item.

Parameters:

key - The key

Returns:

The new ingredient