Package earth.terrarium.botarium.common.fluid.impl

Class SimpleFluidContainer

java.lang.Object

earth.terrarium.botarium.common.fluid.impl.SimpleFluidContainer

All Implemented Interfaces:

FluidContainer, Serializable, net.minecraft.world.Clearable

Direct Known Subclasses:

ExtractOnlyFluidContainer, InsertOnlyFluidContainer

public class SimpleFluidContainer
extends Object
implements FluidContainer

A simple implementation for fluid storage. This class should be wrapped by a WrappedBlockFluidContainer or a WrappedItemFluidContainer to provide the necessary functionality.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLUID_KEY
final BiPredicate<Integer,FluidHolder>	fluidFilter
final IntToLongFunction	maxAmount
net.minecraft.core.NonNullList<FluidHolder>	storedFluid

Constructor Summary

Constructors

Constructor	Description
SimpleFluidContainer(long maxAmount, int tanks, BiPredicate<Integer,FluidHolder> fluidFilter)
SimpleFluidContainer(IntToLongFunction maxAmount, int tanks, BiPredicate<Integer,FluidHolder> fluidFilter)

Method Summary

Modifier and Type	Method	Description
boolean	allowsExtraction()
boolean	allowsInsertion()
void	clearContent()
SimpleFluidContainer	copy()
FluidSnapshot	createSnapshot()
void	deserialize(net.minecraft.nbt.CompoundTag root)	Deserializes the information of an object from a CompoundTag.
FluidHolder	extractFluid(FluidHolder fluid, boolean simulate)	Extracts a FluidHolder from the container.
long	extractFromSlot(FluidHolder fluidHolder, FluidHolder toInsert, Runnable snapshot)	Extracts a fluid from one FluidHolder into another.
void	fromContainer(FluidContainer container)	Sets the container to the same values as the given container.
List<FluidHolder>	getFluids()
int	getSize()
long	getTankCapacity(int slot)
long	insertFluid(FluidHolder fluid, boolean simulate)	Inserts a FluidHolder into the container.
FluidHolder	internalExtract(FluidHolder fluid, boolean simulate)	An internal version of FluidContainer.extractFluid(FluidHolder, boolean) that is used by mod authors looking to directly interact with their own containers.
long	internalInsert(FluidHolder fluid, boolean simulate)	An internal version of FluidContainer.insertFluid(FluidHolder, boolean) that is used by mod authors looking to directly interact with their own containers.
boolean	isEmpty()
boolean	isFluidValid(int slot, FluidHolder fluidHolder)
net.minecraft.nbt.CompoundTag	serialize(net.minecraft.nbt.CompoundTag root)	Serializes the information of an object to a CompoundTag.
void	setFluid(int slot, FluidHolder fluid)	Sets a given FluidHolder to a slot in the container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface earth.terrarium.botarium.common.fluid.base.FluidContainer

readSnapshot

Field Details

FLUID_KEY

public static final String FLUID_KEY

See Also:

• Constant Field Values

storedFluid

public net.minecraft.core.NonNullList<FluidHolder> storedFluid

maxAmount

public final IntToLongFunction maxAmount

fluidFilter

public final BiPredicate<Integer,FluidHolder> fluidFilter

Constructor Details

SimpleFluidContainer

public SimpleFluidContainer(IntToLongFunction maxAmount,
 int tanks,
 BiPredicate<Integer,FluidHolder> fluidFilter)

SimpleFluidContainer

public SimpleFluidContainer(long maxAmount,
 int tanks,
 BiPredicate<Integer,FluidHolder> fluidFilter)

Method Details

insertFluid

public long insertFluid(FluidHolder fluid,
 boolean simulate)

Description copied from interface: FluidContainer

Inserts a FluidHolder into the container.

Specified by:

insertFluid in interface FluidContainer

Parameters:

fluid - The FluidHolder to be inserted into the container.

simulate - If true, the container will not be modified.

Returns:

The amount of fluid that was added to the container.

extractFluid

public FluidHolder extractFluid(FluidHolder fluid,
 boolean simulate)

Description copied from interface: FluidContainer

Extracts a FluidHolder from the container.

Specified by:

extractFluid in interface FluidContainer

Parameters:

fluid - The FluidHolder to be extracted from the container.

simulate - If true, the container will not be modified.

Returns:

The FluidHolder that was extracted from the container.

internalInsert

public long internalInsert(FluidHolder fluid,
 boolean simulate)

Description copied from interface: FluidContainer

An internal version of FluidContainer.insertFluid(FluidHolder, boolean) that is used by mod authors looking to directly interact with their own containers.

You should not call this method for other mod's containers, instead use FluidContainer.insertFluid(FluidHolder, boolean).

Specified by:

internalInsert in interface FluidContainer

internalExtract

public FluidHolder internalExtract(FluidHolder fluid,
 boolean simulate)

Description copied from interface: FluidContainer

An internal version of FluidContainer.extractFluid(FluidHolder, boolean) that is used by mod authors looking to directly interact with their own containers.

You should not call this method for other mod's containers, instead use FluidContainer.extractFluid(FluidHolder, boolean).

Specified by:

internalExtract in interface FluidContainer

extractFromSlot

public long extractFromSlot(FluidHolder fluidHolder,
 FluidHolder toInsert,
 Runnable snapshot)

Description copied from interface: FluidContainer

Extracts a fluid from one FluidHolder into another.

Specified by:

extractFromSlot in interface FluidContainer

Parameters:

fluidHolder - The FluidHolder to extract from.

toInsert - The FluidHolder to insert into. With amount clamped between 0-fluid.getFluidAmount().

snapshot - A runnable that will be called before the extraction happens.

Returns:

The amount of fluid that was extracted.

setFluid

public void setFluid(int slot,
 FluidHolder fluid)

Description copied from interface: FluidContainer

Sets a given FluidHolder to a slot in the container.

Specified by:

setFluid in interface FluidContainer

Parameters:

slot - The slot to set the fluid in.

fluid - The FluidHolder to set in the slot.

getFluids

public List<FluidHolder> getFluids()

Specified by:

getFluids in interface FluidContainer

Returns:

A List of FluidHolder in the container.

getSize

public int getSize()

Specified by:

getSize in interface FluidContainer

Returns:

The amount of slots in the container.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface FluidContainer

Returns:

Weather or not the container is empty.

copy

public SimpleFluidContainer copy()

Specified by:

copy in interface FluidContainer

Returns:

A copy of the container.

getTankCapacity

public long getTankCapacity(int slot)

Specified by:

getTankCapacity in interface FluidContainer

Parameters:

slot - The slot to get the capacity of.

Returns:

The capacity of the given slot.

fromContainer

public void fromContainer(FluidContainer container)

Description copied from interface: FluidContainer

Sets the container to the same values as the given container.

Specified by:

fromContainer in interface FluidContainer

Parameters:

container - The container to copy the fluids from.

deserialize

public void deserialize(net.minecraft.nbt.CompoundTag root)

Description copied from interface: Serializable

Deserializes the information of an object from a CompoundTag.

Specified by:

deserialize in interface Serializable

Parameters:

root - The CompoundTag to deserialize from.

serialize

public net.minecraft.nbt.CompoundTag serialize(net.minecraft.nbt.CompoundTag root)

Description copied from interface: Serializable

Serializes the information of an object to a CompoundTag.

Specified by:

serialize in interface Serializable

Parameters:

root - The CompoundTag to serialize to.

Returns:

The CompoundTag that was passed in but with the information of the object serialized added to it.

allowsInsertion

public boolean allowsInsertion()

Specified by:

allowsInsertion in interface FluidContainer

Returns:

Weather can be inserted into.

allowsExtraction

public boolean allowsExtraction()

Specified by:

allowsExtraction in interface FluidContainer

Returns:

Weather can be extracted from.

isFluidValid

public boolean isFluidValid(int slot,
 FluidHolder fluidHolder)

Specified by:

isFluidValid in interface FluidContainer

fluidHolder - The FluidHolder to check if can be inserted into.

Returns:

Weather the given FluidHolder can be inserted into.

createSnapshot

public FluidSnapshot createSnapshot()

Specified by:

createSnapshot in interface FluidContainer

Returns:

A FluidSnapshot of the given state of the FluidContainer.

clearContent

public void clearContent()

Specified by:

clearContent in interface net.minecraft.world.Clearable