Package net.neoforged.neoforge.fluids.crafting

Class DataComponentFluidIngredient

java.lang.Object

net.neoforged.neoforge.fluids.crafting.FluidIngredient

net.neoforged.neoforge.fluids.crafting.DataComponentFluidIngredient

All Implemented Interfaces:

Predicate<FluidStack>

public class DataComponentFluidIngredient
extends FluidIngredient

Fluid ingredient that matches the given set of fluids, additionally performing either a strict or partial test on the FluidStack's components.

Strict ingredients will only match fluid stacks that have exactly the provided components, while partial ones will match if the stack's components contain all required components for the input predicate.

See Also:

• DataComponentIngredient, its item equivalent

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<DataComponentFluidIngredient>	CODEC
private final DataComponentPredicate	components
private final HolderSet<Fluid>	fluids
private final FluidStack[]	stacks
private final boolean	strict

Fields inherited from class net.neoforged.neoforge.fluids.crafting.FluidIngredient

CODEC_NON_EMPTY, LIST_CODEC, LIST_CODEC_NON_EMPTY, MAP_CODEC_NONEMPTY, STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
DataComponentFluidIngredient(HolderSet<Fluid> fluids, DataComponentPredicate components, boolean strict)

Method Summary

Modifier and Type	Method	Description
DataComponentPredicate	components()
boolean	equals(Object obj)
HolderSet<Fluid>	fluids()
Stream<FluidStack>	generateStacks()	Generates a stream of all fluid stacks this ingredient matches against.
FluidIngredientType<?>	getType()	Returns The type of this fluid ingredient..
int	hashCode()
boolean	isSimple()	Returns whether this fluid ingredient always requires direct stack testing.
boolean	isStrict()
static <T> FluidIngredient	of(boolean strict, Supplier<? extends DataComponentType<? super T>> type, T value, Fluid... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentMap map, Holder<Fluid>... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentMap map, HolderSet<Fluid> fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentMap map, Fluid... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentPredicate predicate, Holder<Fluid>... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentPredicate predicate, HolderSet<Fluid> fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, DataComponentPredicate predicate, Fluid... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static <T> FluidIngredient	of(boolean strict, DataComponentType<? super T> type, T value, Fluid... fluids)	Creates a new ingredient matching any fluid from the list, containing the given components
static FluidIngredient	of(boolean strict, FluidStack stack)	Creates a new ingredient matching the given fluid, containing the given components
boolean	test(FluidStack stack)	Checks if a given fluid stack matches this ingredient.

Methods inherited from class net.neoforged.neoforge.fluids.crafting.FluidIngredient

empty, getStacks, hasNoFluids, isEmpty, of, of, of, single, single, single, tag

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Details

CODEC

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

fluids

private final HolderSet<Fluid> fluids

components

private final DataComponentPredicate components

strict

private final boolean strict

stacks

private final FluidStack[] stacks

Constructor Details

DataComponentFluidIngredient

public DataComponentFluidIngredient(HolderSet<Fluid> fluids,
 DataComponentPredicate components,
 boolean strict)

Method Details

test

public boolean test(FluidStack stack)

Description copied from class: FluidIngredient

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

Specified by:

test in interface Predicate<FluidStack>

Specified by:

test in class FluidIngredient

Parameters:

stack - the stack to test

Returns:

true if the stack matches, false otherwise

generateStacks

public Stream<FluidStack> generateStacks()

Description copied from class: FluidIngredient

Generates a stream of all fluid stacks this ingredient matches against.

For compatibility reasons, implementations should follow the same guidelines as for custom item ingredients, i.e.:

• These stacks are generally used for display purposes, and need not be exhaustive or perfectly accurate.
• An exception is ingredients that are simple, for which it is important that the returned stacks correspond exactly to all the accepted Fluids.
• At least one stack should always be returned, otherwise the ingredient may be considered accidentally empty.
• The ingredient should try to return at least one stack with each accepted Fluid. This allows mods that inspect the ingredient to figure out which stacks it might accept.

Specified by:

generateStacks in class FluidIngredient

Returns:

a stream of all fluid stacks this ingredient accepts.

Note: No guarantees are made as to the amount of the fluid, as FluidIngredients are generally not meant to match by amount and these stacks are mostly used for display.

See Also:

• ICustomIngredient.getItems()

isSimple

public boolean isSimple()

Description copied from class: FluidIngredient

Returns whether this fluid ingredient always requires direct stack testing.

Specified by:

isSimple in class FluidIngredient

Returns:

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

See Also:

• ICustomIngredient.isSimple()

getType

public FluidIngredientType<?> getType()

Description copied from class: FluidIngredient

Returns The type of this fluid ingredient..

The type must be registered to NeoForgeRegistries.FLUID_INGREDIENT_TYPES.

Specified by:

getType in class FluidIngredient

Returns:

The type of this fluid ingredient.

hashCode

public int hashCode()

Specified by:

hashCode in class FluidIngredient

equals

public boolean equals(Object obj)

Specified by:

equals in class FluidIngredient

fluids

public HolderSet<Fluid> fluids()

components

public DataComponentPredicate components()

isStrict

public boolean isStrict()

of

public static FluidIngredient of(boolean strict,
 FluidStack stack)

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

of

public static <T> FluidIngredient of(boolean strict,
 DataComponentType<? super T> type,
 T value,
 Fluid... fluids)

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

of

public static <T> FluidIngredient of(boolean strict,
 Supplier<? extends DataComponentType<? super T>> type,
 T value,
 Fluid... fluids)

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

of

public static FluidIngredient of(boolean strict,
 DataComponentMap map,
 Fluid... fluids)

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

of

@SafeVarargs
public static FluidIngredient of(boolean strict,
 DataComponentMap map,
 Holder<Fluid>... fluids)

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

of

public static FluidIngredient of(boolean strict,
 DataComponentMap map,
 HolderSet<Fluid> fluids)

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

of

@SafeVarargs
public static FluidIngredient of(boolean strict,
 DataComponentPredicate predicate,
 Holder<Fluid>... fluids)

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

of

public static FluidIngredient of(boolean strict,
 DataComponentPredicate predicate,
 Fluid... fluids)

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

of

public static FluidIngredient of(boolean strict,
 DataComponentPredicate predicate,
 HolderSet<Fluid> fluids)

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