Package net.fabricmc.fabric.api.transfer.v1.fluid.base

Class FullItemFluidStorage

java.lang.Object

net.fabricmc.fabric.api.transfer.v1.fluid.base.FullItemFluidStorage

All Implemented Interfaces:

Iterable<StorageView<FluidVariant>>, ExtractionOnlyStorage<FluidVariant>, SingleSlotStorage<FluidVariant>, SlottedStorage<FluidVariant>, Storage<FluidVariant>, StorageView<FluidVariant>

@Experimental
public final class FullItemFluidStorage
extends Object
implements ExtractionOnlyStorage<FluidVariant>, SingleSlotStorage<FluidVariant>

Base implementation of a fluid storage for a full item. The full item contains some fixed amount of a fluid variant, which can be extracted entirely to yield an empty item. The default behavior is to copy the NBT from the full item to the empty item, however there is a second constructor that allows customizing the mapping.

This is used similarly to EmptyItemFluidStorage.

Experimental feature, we reserve the right to remove or change it without further notice. The transfer API is a complex addition, and we want to be able to correct possible design mistakes.

Constructor Summary

Constructors

Constructor	Description
FullItemFluidStorage(ContainerItemContext context, Function<ItemVariant,ItemVariant> fullToEmptyMapping, FluidVariant containedFluid, long containedAmount)	Create a new instance, with a custom mapping function.
FullItemFluidStorage(ContainerItemContext context, Item emptyItem, FluidVariant containedFluid, long containedAmount)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
long	extract(FluidVariant resource, long maxAmount, TransactionContext transaction)	Try to extract up to some amount of a resource from this storage.
long	getAmount()
long	getCapacity()
FluidVariant	getResource()
boolean	isResourceBlank()	Return true if the StorageView.getResource() contained in this storage view is blank, or false otherwise.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.base.ExtractionOnlyStorage

insert, supportsInsertion

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.base.SingleSlotStorage

getSlot, getSlotCount, iterator

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.SlottedStorage

getSlots

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.Storage

exactView, getVersion, nonEmptyIterator, nonEmptyViews, simulateExtract, simulateInsert, supportsExtraction

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.StorageView

getUnderlyingView

Constructor Details

FullItemFluidStorage

public FullItemFluidStorage(ContainerItemContext context,
 Item emptyItem,
 FluidVariant containedFluid,
 long containedAmount)

Create a new instance.

Parameters:

context - The current context.

emptyItem - The new item after a successful extract operation.

containedFluid - The contained fluid variant.

containedAmount - How much of containedFluid is contained.

FullItemFluidStorage

public FullItemFluidStorage(ContainerItemContext context,
 Function<ItemVariant,ItemVariant> fullToEmptyMapping,
 FluidVariant containedFluid,
 long containedAmount)

Create a new instance, with a custom mapping function. The mapping function allows customizing how the NBT of the empty item depends on the NBT of the full item. The default behavior with the other constructor is to just copy the full NBT.

Parameters:

context - The current context.

fullToEmptyMapping - A function mapping the full item variant, to the variant that should be used for the empty item after a successful extract operation.

containedFluid - The contained fluid variant.

containedAmount - How much of containedFluid is contained.

Method Details

extract

public long extract(FluidVariant resource,
 long maxAmount,
 TransactionContext transaction)

Description copied from interface: Storage

Try to extract up to some amount of a resource from this storage.

Specified by:

extract in interface Storage<FluidVariant>

Specified by:

extract in interface StorageView<FluidVariant>

Parameters:

resource - The resource to extract. May not be blank.

maxAmount - The maximum amount of resource to extract. May not be negative.

transaction - The transaction this operation is part of.

Returns:

A non-negative integer not greater than maxAmount: the amount that was extracted.

isResourceBlank

public boolean isResourceBlank()

Description copied from interface: StorageView

Return true if the StorageView.getResource() contained in this storage view is blank, or false otherwise.

This function is mostly useful when dealing with storages of arbitrary types. For transfer variant storages, this should always be equivalent to getResource().isBlank().

Specified by:

isResourceBlank in interface StorageView<FluidVariant>

getResource

public FluidVariant getResource()

Specified by:

getResource in interface StorageView<FluidVariant>

Returns:

The resource stored in this view. May not be blank if StorageView.isResourceBlank() is false.

getAmount

public long getAmount()

Specified by:

getAmount in interface StorageView<FluidVariant>

Returns:

The amount of StorageView.getResource() stored in this view.

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface StorageView<FluidVariant>

Returns:

The total amount of StorageView.getResource() that could be stored in this view, or an estimated upper bound on the number of resources that could be stored if this view has a blank resource.

toString

public String toString()

Overrides:

toString in class Object