Package net.neoforged.neoforge.transfer.fluid

Class FluidStacksResourceHandler

java.lang.Object

net.neoforged.neoforge.transfer.StacksResourceHandler<FluidStack,FluidResource>

net.neoforged.neoforge.transfer.fluid.FluidStacksResourceHandler

All Implemented Interfaces:

ValueIOSerializable, ResourceHandler<FluidResource>

public class FluidStacksResourceHandler
extends StacksResourceHandler<FluidStack,FluidResource>

Base implementation of a ResourceHandler<FluidResource> backed by a list of FluidStacks.

The following methods will typically be overridden:

• (optional) StacksResourceHandler.isValid(int, T) to limit which resources are allowed in this handler; by default any resource is allowed.
• (optional) getCapacity(int, net.neoforged.neoforge.transfer.fluid.FluidResource) to specify the capacity of this handler; by default the capacity given in the constructor is used.
• (recommended) StacksResourceHandler.onContentsChanged(int, S) to react to changes in this handler, for example to trigger setChanged().

Field Summary

Fields

Modifier and Type	Field	Description
protected int	capacity

Fields inherited from class net.neoforged.neoforge.transfer.StacksResourceHandler

codec, emptyStack, stacks, VALUE_IO_KEY

Constructor Summary

Constructors

Constructor	Description
FluidStacksResourceHandler(int size, int capacity)
FluidStacksResourceHandler(NonNullList<FluidStack> stacks, int capacity)

Method Summary

Modifier and Type	Method	Description
protected FluidStack	copyOf(FluidStack stack)	Creates a copy of a stack, for use as a snapshot.
int	getAmountFrom(FluidStack stack)	Retrieves the amount from a stack.
protected int	getCapacity(int index, FluidResource resource)	Return the maximum capacity of this handler for the passed resource.
FluidResource	getResourceFrom(FluidStack stack)	Retrieves the resource from a stack.
protected FluidStack	getStackFrom(FluidResource resource, int amount)	Creates a stack from a resource and an amount.
boolean	matches(FluidStack stack, FluidResource resource)	Checks if the passed resource corresponds to the stack.

Methods inherited from class net.neoforged.neoforge.transfer.StacksResourceHandler

copyToList, deserialize, extract, getAmountAsLong, getCapacityAsLong, getResource, insert, isValid, onContentsChanged, serialize, set, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.neoforge.transfer.ResourceHandler

extract, getAmountAsInt, getCapacityAsInt, insert

Field Details

capacity

protected int capacity

Constructor Details

FluidStacksResourceHandler

public FluidStacksResourceHandler(int size,
 int capacity)

FluidStacksResourceHandler

public FluidStacksResourceHandler(NonNullList<FluidStack> stacks,
 int capacity)

Method Details

getResourceFrom

public FluidResource getResourceFrom(FluidStack stack)

Description copied from class: StacksResourceHandler

Retrieves the resource from a stack. In the case of an ItemStack an ItemResource would be returned for example.

Specified by:

getResourceFrom in class StacksResourceHandler<FluidStack,FluidResource>

getAmountFrom

public int getAmountFrom(FluidStack stack)

Description copied from class: StacksResourceHandler

Retrieves the amount from a stack. In the case of an ItemStack the count would be returned for example.

Specified by:

getAmountFrom in class StacksResourceHandler<FluidStack,FluidResource>

getStackFrom

protected FluidStack getStackFrom(FluidResource resource,
 int amount)

Description copied from class: StacksResourceHandler

Creates a stack from a resource and an amount.

If the stack would be empty, consider returning StacksResourceHandler.emptyStack instead of creating a new empty stack instance.

Specified by:

getStackFrom in class StacksResourceHandler<FluidStack,FluidResource>

getCapacity

protected int getCapacity(int index,
 FluidResource resource)

Description copied from class: StacksResourceHandler

Return the maximum capacity of this handler for the passed resource. If the passed resource is empty, an estimate should be returned.

Specified by:

getCapacity in class StacksResourceHandler<FluidStack,FluidResource>

Returns:

The maximum capacity of this handler for the passed resource.

copyOf

protected FluidStack copyOf(FluidStack stack)

Description copied from class: StacksResourceHandler

Creates a copy of a stack, for use as a snapshot.

If using an immutable stack type such as ResourceStack, it can be returned as is. In the case of a mutable stack type such as an item or fluid stack, a copy should be returned.

Specified by:

copyOf in class StacksResourceHandler<FluidStack,FluidResource>

matches

public boolean matches(FluidStack stack,
 FluidResource resource)

Description copied from class: StacksResourceHandler

Checks if the passed resource corresponds to the stack.

Overrides:

matches in class StacksResourceHandler<FluidStack,FluidResource>

Parameters:

stack - the stack, usually the current stored value

resource - the resource, usually the received value in insert or extract

Returns:

true if the stack and resource match; false otherwise.