Package alexiil.mc.lib.attributes.fluid.item

Class ItemBasedSingleFluidInv

java.lang.Object

alexiil.mc.lib.attributes.misc.AbstractItemBasedAttribute

alexiil.mc.lib.attributes.fluid.item.ItemBasedSingleFluidInv

All Implemented Interfaces:

FluidExtractable, FluidInsertable, FluidTransferable, GroupedFluidInv, GroupedFluidInvView, LimitedConsumer<FluidVolume>

public abstract class ItemBasedSingleFluidInv
extends AbstractItemBasedAttribute
implements GroupedFluidInv

An abstract GroupedFluidInv for an AbstractItemBasedAttribute which only ever contains a single fluid, and can contain any amount of said fluid between 0 and it's capacity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ItemBasedSingleFluidInv.HeldFluidInfo

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.fluid.GroupedFluidInvView

GroupedFluidInvView.FluidInvStatistic

Field Summary

Fields inherited from class alexiil.mc.lib.attributes.misc.AbstractItemBasedAttribute

excessStacks, stackRef

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ItemBasedSingleFluidInv(Reference<net.minecraft.item.ItemStack> stackRef, LimitedConsumer<net.minecraft.item.ItemStack> excessStacks)

Method Summary

Modifier and Type	Method	Description
FluidVolume	attemptExtraction(FluidFilter filter, FluidAmount maxAmount, Simulation simulation)	Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.
FluidVolume	attemptInsertion(FluidVolume fluid, Simulation simulation)	Inserts the given stack into this insertable, and returns the excess.
protected abstract ItemBasedSingleFluidInv.HeldFluidInfo	getInfo(net.minecraft.item.ItemStack stack)
FluidFilter	getInsertionFilter()	The FluidFilter to limit what may be inserted.
GroupedFluidInvView.FluidInvStatistic	getStatistics(FluidFilter filter)
Set<FluidKey>	getStoredFluids()
protected abstract boolean	isInvalid(net.minecraft.item.ItemStack stack)
protected abstract net.minecraft.item.ItemStack	writeToStack(net.minecraft.item.ItemStack stack, FluidVolume fluid)

Methods inherited from class alexiil.mc.lib.attributes.misc.AbstractItemBasedAttribute

setStacks, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface alexiil.mc.lib.attributes.fluid.FluidExtractable

attemptAnyExtraction, attemptAnyExtraction, attemptExtraction, couldExtractAnything, extract, extract, extract, extract, extract, extract, getPureExtractable

Methods inherited from interface alexiil.mc.lib.attributes.fluid.FluidInsertable

getMinimumAcceptedAmount, getPureInsertable, insert, offer, offer, wouldAccept

Methods inherited from interface alexiil.mc.lib.attributes.fluid.GroupedFluidInv

createLimitedGroupedInv, filtered

Methods inherited from interface alexiil.mc.lib.attributes.fluid.GroupedFluidInvView

addListener, addListener_F, getAmount, getAmount, getAmount_F, getAmount_F, getCapacity, getCapacity_F, getGroupedView, getSpace, getSpace_F, getStatistics, getTotalCapacity, getTotalCapacity_F

Constructor Details

ItemBasedSingleFluidInv

protected ItemBasedSingleFluidInv(Reference<net.minecraft.item.ItemStack> stackRef,
 LimitedConsumer<net.minecraft.item.ItemStack> excessStacks)

Method Details

isInvalid

protected abstract boolean isInvalid(net.minecraft.item.ItemStack stack)

Parameters:

stack - The ItemStack to test. This will never be empty.

Returns:

True if the given stack is not a valid target.

getInfo

protected abstract ItemBasedSingleFluidInv.HeldFluidInfo getInfo(net.minecraft.item.ItemStack stack)

Parameters:

stack - The ItemStack of which to look at. This will have already been passed to isInvalid(ItemStack) and returned false. You should ignore the ItemStack.getCount(), and treat it as 1.

Returns:

The information for a given stack.

writeToStack

@Nullable
protected abstract net.minecraft.item.ItemStack writeToStack(net.minecraft.item.ItemStack stack,
 FluidVolume fluid)

Parameters:

stack - The stack to modify. However it is not required that this stack is actually modified, instead you could create a new stack and return it.

Returns:

Either the newly modified stack (if the given fluid was valid), or null if this couldn't write the given fluid to the stack.

getStoredFluids

public Set<FluidKey> getStoredFluids()

Specified by:

getStoredFluids in interface GroupedFluidInvView

Returns:

a set containing all of the FluidKey's that are stored in the inventory.

getStatistics

public GroupedFluidInvView.FluidInvStatistic getStatistics(FluidFilter filter)

Specified by:

getStatistics in interface GroupedFluidInvView

Parameters:

filter - The filter to check on.

Returns:

Statistics about the currently stored amount, capacity, and space for everything that matches the given filter.

getInsertionFilter

public FluidFilter getInsertionFilter()

The FluidFilter to limit what may be inserted. NOTE: subclasses must never call attemptInsertion(FluidVolume, Simulation) from inside this method, or return a FluidFilter whose matches method calls attemptInsertion as this is used by attemptInsertion in order to filter incoming fluids.

Specified by:

getInsertionFilter in interface FluidInsertable

Returns:

A filter to determine if the given fluid could ever be inserted.

attemptInsertion

public FluidVolume attemptInsertion(FluidVolume fluid,
 Simulation simulation)

Description copied from interface: FluidInsertable

Inserts the given stack into this insertable, and returns the excess.

Specified by:

attemptInsertion in interface FluidInsertable

Parameters:

fluid - The incoming fluid. Must not be modified by this call.

simulation - If Simulation.SIMULATE then this shouldn't modify anything.

Returns:

the excess FluidVolume that wasn't accepted. This will be independent of this insertable, however it might be the given object instead of a completely new object.

attemptExtraction

public FluidVolume attemptExtraction(FluidFilter filter,
 FluidAmount maxAmount,
 Simulation simulation)

Description copied from interface: FluidExtractable

Attempt to extract *any* FluidVolume from this that matches the given FluidFilter.

Specified by:

attemptExtraction in interface FluidExtractable

maxAmount - The maximum amount of fluid that can be extracted. Negative numbers throw an exception.

simulation - If Simulation.SIMULATE then this should return the same result that the exact same call with Simulation.ACTION would do, except that the filter can be made more specific between calls if the previously simulated extracted fluid is used as a filter.

For example the following code snippet should never throw an exception:

FluidExtractable from = // Some extractable
FluidVolume attempted = from.attemptAnyExtraction(Integer.MAX_VALUE, Simulation.SIMULATE);
if (attempted.isEmpty()) return;
FluidVolume extracted = from.extract(attempted.getFluidKey(), attempted.getAmount());
assert !extracted.isEmpty;
assert attempted.getAmount() == extracted.getAmount();
assert attempted.getFluidKet() == extracted.getFluidKet();
assert attempted.equals(extracted);

Returns:

A new, independent FluidVolume that was extracted.