Record Class FluidStackTemplate

java.lang.Object

java.lang.Record

net.neoforged.neoforge.fluids.FluidStackTemplate

All Implemented Interfaces:

DataComponentGetter, TypedInstance<Fluid>, FluidInstance

public record FluidStackTemplate(Holder<Fluid> fluid, int amount, DataComponentPatch components)
extends Record
implements FluidInstance

Fluid variant of ItemStackTemplate.

The main difference is that fluid templates are required to have an amount, while item templates default to 1.

Most methods in this class are adopted from ItemStackTemplate.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	amount	The field for the amount record component.
static final com.mojang.serialization.Codec<FluidStackTemplate>	CODEC
private final DataComponentPatch	components	The field for the components record component.
private final Holder<Fluid>	fluid	The field for the fluid record component.
static final com.mojang.serialization.MapCodec<FluidStackTemplate>	MAP_CODEC
static final StreamCodec<RegistryFriendlyByteBuf, FluidStackTemplate>	STREAM_CODEC

Fields inherited from interface FluidInstance

FIELD_AMOUNT, FIELD_COMPONENTS, FIELD_ID, FLUID_HOLDER_CODEC, FLUID_HOLDER_CODEC_WITH_BOUND_COMPONENTS, FLUID_HOLDER_STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
FluidStackTemplate(Holder<Fluid> fluid, int amount)
FluidStackTemplate(Holder<Fluid> fluid, int amount, DataComponentPatch components)	Creates an instance of a FluidStackTemplate record class.
FluidStackTemplate(Fluid fluid, int amount)
FluidStackTemplate(Fluid fluid, int amount, DataComponentPatch components)

Method Summary

Modifier and Type	Method	Description
int	amount()	Returns the value of the amount record component.
FluidStack	apply(int amount, DataComponentPatch additionalPatch)
FluidStack	apply(DataComponentPatch additionalPatch)
DataComponentPatch	components()	Returns the value of the components record component.
FluidStack	create()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static com.mojang.serialization.Codec<FluidStackTemplate>	fixedAmountCodec(int amount)
static StreamCodec<RegistryFriendlyByteBuf, FluidStackTemplate>	fixedAmountStreamCodec(int amount)
Holder<Fluid>	fluid()	Returns the value of the fluid record component.
static FluidStackTemplate	fromNonEmptyStack(FluidStack stack)
<T> @Nullable T	get(DataComponentType<? extends T> type)
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
Holder<Fluid>	typeHolder()
FluidStackTemplate	withAmount(int amount)

Methods inherited from class Object

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

Methods inherited from interface DataComponentGetter

get, getOrDefault, getOrDefault, getTyped, has, has

Methods inherited from interface FluidInstance

getFluidType, is

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

fluid

private final Holder<Fluid> fluid

The field for the fluid record component.

amount

private final int amount

The field for the amount record component.

components

private final DataComponentPatch components

The field for the components record component.

MAP_CODEC

public static final com.mojang.serialization.MapCodec<FluidStackTemplate> MAP_CODEC

CODEC

public static final com.mojang.serialization.Codec<FluidStackTemplate> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, FluidStackTemplate> STREAM_CODEC

Constructor Details

FluidStackTemplate

public FluidStackTemplate(Holder<Fluid> fluid,
 int amount,
 DataComponentPatch components)

Creates an instance of a FluidStackTemplate record class.

Parameters:

fluid - the value for the fluid record component

amount - the value for the amount record component

components - the value for the components record component

FluidStackTemplate

public FluidStackTemplate(Holder<Fluid> fluid,
 int amount)

FluidStackTemplate

public FluidStackTemplate(Fluid fluid,
 int amount,
 DataComponentPatch components)

FluidStackTemplate

public FluidStackTemplate(Fluid fluid,
 int amount)

Method Details

fromNonEmptyStack

public static FluidStackTemplate fromNonEmptyStack(FluidStack stack)

withAmount

public FluidStackTemplate withAmount(int amount)

create

public FluidStack create()

apply

public FluidStack apply(DataComponentPatch additionalPatch)

apply

public FluidStack apply(int amount,
 DataComponentPatch additionalPatch)

typeHolder

public Holder<Fluid> typeHolder()

Specified by:

typeHolder in interface TypedInstance<Fluid>

get

public <T> @Nullable T get(DataComponentType<? extends T> type)

Specified by:

get in interface DataComponentGetter

fixedAmountCodec

public static com.mojang.serialization.Codec<FluidStackTemplate> fixedAmountCodec(int amount)

fixedAmountStreamCodec

public static StreamCodec<RegistryFriendlyByteBuf, FluidStackTemplate> fixedAmountStreamCodec(int amount)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fluid

public Holder<Fluid> fluid()

Returns the value of the fluid record component.

Returns:

the value of the fluid record component

amount

public int amount()

Returns the value of the amount record component.

Specified by:

amount in interface FluidInstance

Returns:

the value of the amount record component

components

public DataComponentPatch components()

Returns the value of the components record component.

Returns:

the value of the components record component