Class DataComponentIngredient

java.lang.Object

net.neoforged.neoforge.common.crafting.DataComponentIngredient

All Implemented Interfaces:

ICustomIngredient

public class DataComponentIngredient
extends Object
implements ICustomIngredient

Ingredient that matches the given items, and components as defined by a DataComponentPatch.

Strict NBT ingredients will only match items that have exactly the provided tag, while partial ones will match if the item's tags contain all of the elements of the provided one, while allowing for additional elements to exist.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<DataComponentIngredient>	CODEC
private final DataComponentPatch	components
private final boolean	exhaustive
private final HolderSet<Item>	items

Constructor Summary

Constructors

Constructor	Description
DataComponentIngredient(HolderSet<Item> items, DataComponentPatch components, boolean exhaustive)

Method Summary

Modifier and Type	Method	Description
private static DataComponentPatch	asPatch(DataComponentMap map)
DataComponentPatch	components()
boolean	componentsExhaustive()	Returns true if item stacks that have any component not listed in the components of this ingredient will fail to match.
SlotDisplay	display()	Returns the display for this ingredient.
IngredientType<?>	getType()	Returns the type of this ingredient.
boolean	isSimple()	Returns whether this ingredient always requires direct stack testing.
boolean	isStrict()	Deprecated, for removal: This API element is subject to removal in a future version.
Stream<Holder<Item>>	items()	Returns the list of items that this ingredient accepts.
HolderSet<Item>	itemSet()
static <T> Ingredient	of(boolean exhaustive, Supplier<? extends DataComponentType<? super T>> type, T value, ItemLike... items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentMap map, Holder<Item>... items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentMap map, HolderSet<Item> items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentMap map, ItemLike... items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentPatch predicate, Holder<Item>... items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentPatch predicate, HolderSet<Item> items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, DataComponentPatch predicate, ItemLike... items)	Creates a new ingredient matching any item from the list, that contains the components set on the given patch and that does not contain the components removed by the given patch.
static <T> Ingredient	of(boolean exhaustive, DataComponentType<? super T> type, T value, ItemLike... items)	Creates a new ingredient matching any item from the list, containing the given components
static Ingredient	of(boolean exhaustive, ItemStack stack)	Creates a new ingredient matching the given item, containing the given components
static Ingredient	of(boolean exhaustive, ItemStackTemplate stack)	Creates a new ingredient matching the given item, containing the given components
static Ingredient	of(DataComponentPatch predicate, ItemLike... items)	Creates a new ingredient matching any item from the list, that contains the components set on the given patch and that does not contain the components removed by the given patch.
static <T> Ingredient	of(DataComponentType<? super T> type, T value, ItemLike... items)	Creates a new ingredient matching any item from the list, containing the given components
boolean	test(ItemStack stack)	Checks if a stack matches this ingredient.
private boolean	testComponents(DataComponentGetter getter)

Methods inherited from class Object

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

Methods inherited from interface ICustomIngredient

toVanilla

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<DataComponentIngredient> CODEC

items

private final HolderSet<Item> items

components

private final DataComponentPatch components

exhaustive

private final boolean exhaustive

Constructor Details

DataComponentIngredient

public DataComponentIngredient(HolderSet<Item> items,
 DataComponentPatch components,
 boolean exhaustive)

Method Details

test

public boolean test(ItemStack stack)

Description copied from interface: ICustomIngredient

Checks if a stack matches this ingredient. The stack must not be modified in any way.

Specified by:

test in interface ICustomIngredient

Parameters:

stack - the stack to test

Returns:

true if the stack matches this ingredient, false otherwise

testComponents

private boolean testComponents(DataComponentGetter getter)

items

public Stream<Holder<Item>> items()

Description copied from interface: ICustomIngredient

Returns the list of items that this ingredient accepts.

The following guidelines should be followed for good compatibility:

• At least one item must be returned for the ingredient not to be considered empty. Empty ingredients invalidate the entire recipe.
• The ingredient should return all Items it might possible accept. This allows mods that inspect the ingredient to figure out which stacks it might accept.
• Returned items might not always be accepted by the ingredient, as an ingredient might still perform additional NBT-dependent tests.
• An exception is ingredients that are simple, for which testing a stack is equivalent to testing if the item is in the returned list.

Note: no caching needs to be done by the implementation, this is already handled by the ingredient itself.

Specified by:

items in interface ICustomIngredient

Returns:

the list of items that this ingredient accepts

isSimple

public boolean isSimple()

Description copied from interface: ICustomIngredient

Returns whether this ingredient always requires direct stack testing.

Specified by:

isSimple in interface ICustomIngredient

Returns:

true if this ingredient ignores NBT data when matching stacks, false otherwise

See Also:

• Ingredient.isSimple()

getType

public IngredientType<?> getType()

Description copied from interface: ICustomIngredient

Returns the type of this ingredient.

The type must be registered to NeoForgeRegistries.INGREDIENT_TYPES.

Specified by:

getType in interface ICustomIngredient

Returns:

the type of this ingredient

display

public SlotDisplay display()

Description copied from interface: ICustomIngredient

Returns the display for this ingredient.

The display is synced to the client, and is also used to retrieve the ItemStacks that are shown to the client.

Specified by:

display in interface ICustomIngredient

itemSet

public HolderSet<Item> itemSet()

components

public DataComponentPatch components()

componentsExhaustive

public boolean componentsExhaustive()

Returns true if item stacks that have any component not listed in the components of this ingredient will fail to match.

Returns:

true if item stacks that have any component not listed in the components of this ingredient will fail to match

isStrict

@Deprecated(forRemoval=true)
public boolean isStrict()

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

of

public static Ingredient of(boolean exhaustive,
 ItemStack stack)

Creates a new ingredient matching the given item, containing the given components

of

public static Ingredient of(boolean exhaustive,
 ItemStackTemplate stack)

Creates a new ingredient matching the given item, containing the given components

of

public static <T> Ingredient of(DataComponentType<? super T> type,
 T value,
 ItemLike... items)

Creates a new ingredient matching any item from the list, containing the given components

of

public static <T> Ingredient of(boolean exhaustive,
 DataComponentType<? super T> type,
 T value,
 ItemLike... items)

Creates a new ingredient matching any item from the list, containing the given components

of

public static <T> Ingredient of(boolean exhaustive,
 Supplier<? extends DataComponentType<? super T>> type,
 T value,
 ItemLike... items)

Creates a new ingredient matching any item from the list, containing the given components

of

public static Ingredient of(boolean exhaustive,
 DataComponentMap map,
 ItemLike... items)

Creates a new ingredient matching any item from the list, containing the given components

of

@SafeVarargs
public static Ingredient of(boolean exhaustive,
 DataComponentMap map,
 Holder<Item>... items)

Creates a new ingredient matching any item from the list, containing the given components

of

public static Ingredient of(boolean exhaustive,
 DataComponentMap map,
 HolderSet<Item> items)

Creates a new ingredient matching any item from the list, containing the given components

asPatch

private static DataComponentPatch asPatch(DataComponentMap map)

of

@SafeVarargs
public static Ingredient of(boolean exhaustive,
 DataComponentPatch predicate,
 Holder<Item>... items)

Creates a new ingredient matching any item from the list, containing the given components

of

public static Ingredient of(DataComponentPatch predicate,
 ItemLike... items)

Creates a new ingredient matching any item from the list, that contains the components set on the given patch and that does not contain the components removed by the given patch.

of

public static Ingredient of(boolean exhaustive,
 DataComponentPatch predicate,
 ItemLike... items)

Creates a new ingredient matching any item from the list, that contains the components set on the given patch and that does not contain the components removed by the given patch.

Parameters:

exhaustive - If true, no other components besides the components set on the patch are allowed on an item to match.

of

public static Ingredient of(boolean exhaustive,
 DataComponentPatch predicate,
 HolderSet<Item> items)

Creates a new ingredient matching any item from the list, containing the given components