Package net.neoforged.neoforge.transfer.fluid

Class ItemAccessFluidHandler

java.lang.Object

net.neoforged.neoforge.transfer.ItemAccessResourceHandler<FluidResource>

net.neoforged.neoforge.transfer.fluid.ItemAccessFluidHandler

All Implemented Interfaces:

ResourceHandler<FluidResource>

public class ItemAccessFluidHandler
extends ItemAccessResourceHandler<FluidResource>

Base implementation of a simple fluid ResourceHandler backed by an ItemAccess. Data is stored in a SimpleFluidContent component.

This class allows the backing items to contain any partial level of fluid up to its capacity.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	capacity
protected final DataComponentType<SimpleFluidContent>	component
protected final Item	validItem

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

itemAccess, size

Constructor Summary

Constructors

Constructor	Description
ItemAccessFluidHandler(ItemAccess itemAccess, DataComponentType<SimpleFluidContent> component, int capacity)

Method Summary

Modifier and Type	Method	Description
protected int	getAmountFrom(ItemResource accessResource, int index)	Retrieves the amount stored in the current contents of the item access.
protected int	getCapacity(int index, FluidResource resource)	Return the maximum capacity of this handler for the passed resource.
protected FluidResource	getResourceFrom(ItemResource accessResource, int index)	Retrieves the resource stored in the current contents of the item access.
boolean	isValid(int index, FluidResource resource)	Return true if the passed non-empty resource can fit in this handler, false otherwise.
protected ItemResource	update(ItemResource accessResource, int index, FluidResource newResource, int newAmount)	Returns a resource with updated resource and amount.

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

extract, getAmountAsLong, getCapacityAsLong, getResource, insert, 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

validItem

protected final Item validItem

component

protected final DataComponentType<SimpleFluidContent> component

capacity

protected int capacity

Constructor Details

ItemAccessFluidHandler

public ItemAccessFluidHandler(ItemAccess itemAccess,
 DataComponentType<SimpleFluidContent> component,
 int capacity)

Method Details

getResourceFrom

protected FluidResource getResourceFrom(ItemResource accessResource,
 int index)

Description copied from class: ItemAccessResourceHandler

Retrieves the resource stored in the current contents of the item access.

Specified by:

getResourceFrom in class ItemAccessResourceHandler<FluidResource>

getAmountFrom

protected int getAmountFrom(ItemResource accessResource,
 int index)

Description copied from class: ItemAccessResourceHandler

Retrieves the amount stored in the current contents of the item access.

Specified by:

getAmountFrom in class ItemAccessResourceHandler<FluidResource>

See Also:

• ResourceHandler.getAmountAsInt(int)

update

protected ItemResource update(ItemResource accessResource,
 int index,
 FluidResource newResource,
 int newAmount)

Description copied from class: ItemAccessResourceHandler

Returns a resource with updated resource and amount.

Specified by:

update in class ItemAccessResourceHandler<FluidResource>

Parameters:

accessResource - current resource, before the update

index - the index at which the resource and amount should be updated

newResource - the new resource, never empty: empty is indicated by a 0 amount

newAmount - the new amount

Returns:

accessResource updated with the new resource and amount, or ItemResource.EMPTY if the new resource or amount cannot be stored

isValid

public boolean isValid(int index,
 FluidResource resource)

Description copied from class: ItemAccessResourceHandler

Return true if the passed non-empty resource can fit in this handler, false otherwise.

The result of this function is used in the provided implementations of:

• ItemAccessResourceHandler.getCapacityAsLong(int, T), to report a capacity of 0 for invalid items;
• ItemAccessResourceHandler.insert(int, T, int, TransactionContext), to reject items that cannot fit in this handler.

Specified by:

isValid in interface ResourceHandler<FluidResource>

Overrides:

isValid in class ItemAccessResourceHandler<FluidResource>

Parameters:

index - The index to check.

resource - The resource to check. Must be non-empty.

Returns:

whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index

See Also:

• ResourceHandler.isValid(int, T)

getCapacity

protected int getCapacity(int index,
 FluidResource resource)

Description copied from class: ItemAccessResourceHandler

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 ItemAccessResourceHandler<FluidResource>

Returns:

The maximum capacity of this handler for the passed resource.

See Also:

• ResourceHandler.getCapacityAsInt(int, T)