Class SingleFluidStorage

java.lang.Object

net.fabricmc.fabric.api.transfer.v1.transaction.base.SnapshotParticipant<ResourceAmount<FluidVariant>>

net.fabricmc.fabric.api.transfer.v1.storage.base.SingleVariantStorage<FluidVariant>

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

All Implemented Interfaces:

Iterable<StorageView<FluidVariant>>, SingleSlotStorage<FluidVariant>, SlottedStorage<FluidVariant>, Storage<FluidVariant>, StorageView<FluidVariant>, TransactionContext.CloseCallback, TransactionContext.OuterCloseCallback

public abstract class SingleFluidStorage
extends SingleVariantStorage<FluidVariant>

A storage that can store a single fluid variant at any given time. Implementors should at least override getCapacity(FluidVariant), and probably SnapshotParticipant.onFinalCommit() as well for setChanged() and similar calls.

This is a convenient specialization of SingleVariantStorage for fluids that additionally offers methods to deserialize the contents of the storage.

Field Summary

Fields inherited from class SingleVariantStorage

amount, variant

Constructor Summary

Constructors

Constructor	Description
SingleFluidStorage()

Method Summary

Modifier and Type	Method	Description
protected final FluidVariant	getBlankVariant()	Return the blank variant.
void	readValue(net.minecraft.world.level.storage.ValueInput value)	Simple implementation of reading from ValueInput, to match what is written by writeValue(ValueOutput).
static SingleFluidStorage	withFixedCapacity(long capacity, Runnable onChange)	Create a fluid storage with a fixed capacity and a change handler.
void	writeValue(net.minecraft.world.level.storage.ValueOutput value)	Simple implementation of writing to ValueOutput.

Methods inherited from class SingleVariantStorage

canExtract, canInsert, createSnapshot, extract, getAmount, getCapacity, getCapacity, getResource, insert, isResourceBlank, readSnapshot, readValue, toString, writeValue

Methods inherited from class SnapshotParticipant

afterOuterClose, onClose, onFinalCommit, releaseSnapshot, updateSnapshots

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface SingleSlotStorage

getSlot, getSlotCount, iterator

Methods inherited from interface SlottedStorage

getSlots

Methods inherited from interface Storage

getVersion, nonEmptyIterator, nonEmptyViews, supportsExtraction, supportsInsertion

Methods inherited from interface StorageView

getUnderlyingView

Constructor Details

SingleFluidStorage

public SingleFluidStorage()

Method Details

withFixedCapacity

public static SingleFluidStorage withFixedCapacity(long capacity,
 Runnable onChange)

Create a fluid storage with a fixed capacity and a change handler.

Parameters:

capacity - Fixed capacity of the fluid storage. Must be non-negative.

onChange - Change handler, generally for setChanged() or similar calls. May not be null.

getBlankVariant

protected final FluidVariant getBlankVariant()

Description copied from class: SingleVariantStorage

Return the blank variant.

Note: this is called very early in the constructor. If fields need to be accessed from this function, make sure to re-initialize SingleVariantStorage.variant yourself.

Specified by:

getBlankVariant in class SingleVariantStorage<FluidVariant>

readValue

public void readValue(net.minecraft.world.level.storage.ValueInput value)

Simple implementation of reading from ValueInput, to match what is written by writeValue(ValueOutput). Other formats are allowed, this is just a suggestion.

writeValue

public void writeValue(net.minecraft.world.level.storage.ValueOutput value)

Simple implementation of writing to ValueOutput. Other formats are allowed, this is just a convenient suggestion.