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

Interface Ingredient

All Superinterfaces:

Predicate<ItemStack>

public interface Ingredient
extends 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.
List<ItemStackSnapshot>	displayedItems()	Returns the list of ItemStackSnapshots used to display the ingredient in a recipe.
static Ingredient	empty()	An empty ingredient.
static Ingredient	of(ItemStack @Nullable ... items)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(ItemStackLike...) instead.
static Ingredient	of(ItemStackLike @Nullable ... items)	Creates a new Ingredient for the provided ItemStackLikes.
static Ingredient	of(ItemStackSnapshot @Nullable ... items)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(ItemStackLike...) instead.
static Ingredient	of(ItemType @Nullable ... itemTypes)	Creates a new Ingredient for the provided ItemTypes.
static Ingredient	of(DefaultedRegistryReference<? extends ItemType> @Nullable ... 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, Predicate<? super ItemStackLike> predicate, ItemStackLike... exemplaryStacks)	Creates a new Ingredient for the provided Predicate and exemplary ItemStackLikes.
static Ingredient	of(ResourceKey key, Predicate<ItemStack> predicate, ItemStack... exemplaryStacks)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(ResourceKey, Predicate, ItemStackLike...) instead.
boolean	test(ItemStackLike item)

Methods inherited from interface java.util.function.Predicate

and, negate, or, test

Method Details

empty

static Ingredient empty()

An empty ingredient.

Returns:

The empty ingredient

test

boolean test(ItemStackLike item)

displayedItems

List<ItemStackSnapshot> displayedItems()

Returns the list of ItemStackSnapshots 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(ItemType @Nullable ... itemTypes)

Creates a new Ingredient for the provided ItemTypes.

Parameters:

itemTypes - The items

Returns:

The new ingredient

of

@Deprecated(forRemoval=true)
static Ingredient of(ItemStack @Nullable ... items)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(ItemStackLike...) instead.

of

@Deprecated(forRemoval=true)
static Ingredient of(ItemStackSnapshot @Nullable ... items)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(ItemStackLike...) instead.

of

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

Creates a new Ingredient for the provided ItemStackLikes.

Parameters:

items - The item

Returns:

The new ingredient

of

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

Creates a new Ingredient for the provided ItemTypes.

Parameters:

itemTypes - The items

Returns:

The new ingredient

of

@Deprecated(forRemoval=true)
static Ingredient of(ResourceKey key,
 Predicate<ItemStack> predicate,
 ItemStack... exemplaryStacks)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(ResourceKey, Predicate, ItemStackLike...) instead.

of

static Ingredient of(ResourceKey key,
 Predicate<? super ItemStackLike> predicate,
 ItemStackLike... exemplaryStacks)

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

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