Package alexiil.mc.lib.attributes.fluid.impl

Class SimpleFixedFluidInv

java.lang.Object

alexiil.mc.lib.attributes.fluid.impl.SimpleFixedFluidInv

All Implemented Interfaces:

Convertible, FixedFluidInv, FixedFluidInvView, FluidExtractable, FluidInsertable, FluidTransferable, LimitedConsumer<FluidVolume>, Saveable

Direct Known Subclasses:

JumboFixedFluidInv

public class SimpleFixedFluidInv
extends Object
implements FixedFluidInv, FluidTransferable, Saveable

A simple, extendible, fixed size item inventory that supports all of the features that FixedFluidInv exposes.

Extending classes should take care to override getFilterForTank(int) if they also override isFluidValidForTank(int, FluidKey).

Note: Generally it is better to extend JumboFixedFluidInv for inventories with a large number of similar tanks (like a chest).

Field Summary

Fields

Modifier and Type	Field	Description
final int	tankCapacity	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by tankCapacity_F
final FluidAmount	tankCapacity_F
protected final net.minecraft.util.collection.DefaultedList<FluidVolume>	tanks

Constructor Summary

Constructors

Constructor	Description
SimpleFixedFluidInv(int invSize, int tankCapacity)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by SimpleFixedFluidInv(int, FluidAmount).
SimpleFixedFluidInv(int invSize, FluidAmount tankCapacity)

Method Summary

Modifier and Type	Method	Description
ListenerToken	addListener(FluidInvTankChangeListener listener, ListenerRemovalToken removalToken)	Adds the given listener to this inventory, such that the FluidInvTankChangeListener.onChange(FixedFluidInvView, int, FluidVolume, FluidVolume) will be called every time that this inventory changes.
FluidVolume	attemptAnyExtraction(FluidAmount maxAmount, Simulation simulation)	Calls attemptExtraction() with an FluidFilter of ConstantFluidFilter.ANYTHING.
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 final void	fireTankChange(int tank, FluidVolume previous, FluidVolume current)
void	fromTag(net.minecraft.nbt.NbtCompound tag)
FluidFilter	getFilterForTank(int tank)	Exposes FixedFluidInvView.isFluidValidForTank(int, FluidKey) as a (potentially) readable filter.
GroupedFluidInv	getGroupedInv()
FluidFilter	getInsertionFilter()	Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid.
FluidVolume	getInvFluid(int tank)
int	getMaxAmount(int tank)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by getMaxAmount_F(int).
FluidAmount	getMaxAmount_F(int tank)
FluidAmount	getMinimumAcceptedAmount()
final int	getTankCount()
void	invalidateListeners()
boolean	isFluidValidForTank(int tank, FluidKey fluid)	Checks to see if the given fluid would be valid for this tank, ignoring current contents.
boolean	setInvFluid(int tank, FluidVolume to, Simulation simulation)	Sets the fluid in the given tank to the given fluid.
void	setOwnerListener(FluidInvTankChangeListener ownerListener)	Sets the owner listener callback, which is never removed from the listener list when invalidateListeners() is called.
final net.minecraft.nbt.NbtCompound	toTag()
net.minecraft.nbt.NbtCompound	toTag(net.minecraft.nbt.NbtCompound tag)

Methods inherited from class java.lang.Object

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

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

createLimitedFixedInv, extractFluid, forceSetInvFluid, getExtractable, getInsertable, getMappedInv, getSubInv, getTank, getTransferable, insertFluid, modifyTank, tankIterable

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

convertTo, fluidIterable, getFixedView, offerSelfAsAttribute

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

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

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

getPureInsertable, insert, offer, offer, wouldAccept

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

filtered

Field Details

tankCapacity

@Deprecated(since="0.6.0",
            forRemoval=true)
public final int tankCapacity

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by tankCapacity_F

tankCapacity_F

public final FluidAmount tankCapacity_F

tanks

protected final net.minecraft.util.collection.DefaultedList<FluidVolume> tanks

Constructor Details

SimpleFixedFluidInv

@Deprecated(since="0.6.0",
            forRemoval=true)
public SimpleFixedFluidInv(int invSize,
 int tankCapacity)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by SimpleFixedFluidInv(int, FluidAmount).

SimpleFixedFluidInv

public SimpleFixedFluidInv(int invSize,
 FluidAmount tankCapacity)

Method Details

getTankCount

public final int getTankCount()

Specified by:

getTankCount in interface FixedFluidInvView

Returns:

The number of tanks in this inventory.

getMaxAmount

@Deprecated(since="0.6.0",
            forRemoval=true)
public int getMaxAmount(int tank)

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by getMaxAmount_F(int).

Specified by:

getMaxAmount in interface FixedFluidInvView

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

The maximum amount that the given tank can hold of the given fluid. This method will ignore the current stack in FixedFluidInvView.getInvFluid(int). Note that any setters that this object implements (like FixedFluidInv.setInvFluid(int, FluidVolume, Simulation) should reject stacks that are greater than this value. (and callers should only call this if they need to check the amounts separately. Note that it is meaningless to return values greater than the maximum amount an fluid can be stacked to here, and callers are free to throw an exception if this is violated. (Basically huge single-tank inventories shouldn't implement this interface).

getMaxAmount_F

public FluidAmount getMaxAmount_F(int tank)

Specified by:

getMaxAmount_F in interface FixedFluidInvView

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

The maximum amount that the given tank can hold of the given fluid. This method will ignore the current stack in FixedFluidInvView.getInvFluid(int). Note that any setters that this object implements (like FixedFluidInv.setInvFluid(int, FluidVolume, Simulation) should reject stacks that are greater than this value. (and callers should only call this if they need to check the amounts separately. Note that it is meaningless to return values greater than the maximum amount an fluid can be stacked to here, and callers are free to throw an exception if this is violated. (Basically huge single-tank inventories shouldn't implement this interface).

getInvFluid

public FluidVolume getInvFluid(int tank)

Specified by:

getInvFluid in interface FixedFluidInvView

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

The FluidVolume that is held in the tank at the moment. The returned volume must never be modified!

isFluidValidForTank

public boolean isFluidValidForTank(int tank,
 FluidKey fluid)

Description copied from interface: FixedFluidInv

Checks to see if the given fluid would be valid for this tank, ignoring current contents. Note that this method should adhere to the requirements of FluidFilter.matches(FluidKey), so passing empty fluids will generally not return useful results.

Note that just because an FluidKey passes this validity test, and is mergable with the current fluid, does not mean that you can insert the fluid into this inventory.

Specified by:

isFluidValidForTank in interface FixedFluidInv

Specified by:

isFluidValidForTank in interface FixedFluidInvView

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

getFilterForTank

public FluidFilter getFilterForTank(int tank)

Description copied from interface: FixedFluidInvView

Exposes FixedFluidInvView.isFluidValidForTank(int, FluidKey) as a (potentially) readable filter.

Specified by:

getFilterForTank in interface FixedFluidInvView

Parameters:

tank - The tank index. Must be a value between 0 (inclusive) and FixedFluidInvView.getTankCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

An FluidFilter for this tank. If this tank is filtered by an FluidFilter internally then it is highly recommended that this be overridden to return that filter rather than the default opaque wrapper around FixedFluidInvView.isFluidValidForTank(int, FluidKey).

setInvFluid

public boolean setInvFluid(int tank,
 FluidVolume to,
 Simulation simulation)

Description copied from interface: FixedFluidInv

Sets the fluid in the given tank to the given fluid.

Specified by:

setInvFluid in interface FixedFluidInv

Returns:

True if the modification was allowed, false otherwise. (For example if the given stack doesn't pass the FixedFluidInvView.isFluidValidForTank(int, FluidKey) test).

getGroupedInv

public GroupedFluidInv getGroupedInv()

Specified by:

getGroupedInv in interface FixedFluidInv

Specified by:

getGroupedInv in interface FixedFluidInvView

Returns:

A statistical view of this inventory.

addListener

public ListenerToken addListener(FluidInvTankChangeListener listener,
 ListenerRemovalToken removalToken)

Description copied from interface: FixedFluidInvView

Adds the given listener to this inventory, such that the FluidInvTankChangeListener.onChange(FixedFluidInvView, int, FluidVolume, FluidVolume) will be called every time that this inventory changes. However if this inventory doesn't support listeners then this will return a null token.

Specified by:

addListener in interface FixedFluidInvView

removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).

Returns:

A token that represents the listener, or null if the listener could not be added.

setOwnerListener

public void setOwnerListener(FluidInvTankChangeListener ownerListener)

Sets the owner listener callback, which is never removed from the listener list when invalidateListeners() is called.

invalidateListeners

public void invalidateListeners()

fireTankChange

protected final void fireTankChange(int tank,
 FluidVolume previous,
 FluidVolume current)

toTag

public final net.minecraft.nbt.NbtCompound toTag()

Specified by:

toTag in interface Saveable

toTag

public net.minecraft.nbt.NbtCompound toTag(net.minecraft.nbt.NbtCompound tag)

Specified by:

toTag in interface Saveable

fromTag

public void fromTag(net.minecraft.nbt.NbtCompound tag)

Specified by:

fromTag in interface Saveable

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.

getMinimumAcceptedAmount

public FluidAmount getMinimumAcceptedAmount()

Specified by:

getMinimumAcceptedAmount in interface FluidInsertable

Returns:

The minimum amount of fluid that FluidInsertable.attemptInsertion(FluidVolume, Simulation) will actually accept. Note that this only provides a guarantee that fluid volumes with an amount less than this will never be accepted.

A null return value indicates that there is no minimum value.

getInsertionFilter

public FluidFilter getInsertionFilter()

Description copied from interface: FluidInsertable

Returns an FluidFilter to determine if FluidInsertable.attemptInsertion(FluidVolume, Simulation) could ever accept a fluid. The default implementation is to return ConstantFluidFilter.ANYTHING, and so it is recommended that custom insertables override this to return a more accurate filter.

Specified by:

getInsertionFilter in interface FluidInsertable

Returns:

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

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.

attemptAnyExtraction

public FluidVolume attemptAnyExtraction(FluidAmount maxAmount,
 Simulation simulation)

Description copied from interface: FluidExtractable

Calls attemptExtraction() with an FluidFilter of ConstantFluidFilter.ANYTHING.

Specified by:

attemptAnyExtraction in interface FluidExtractable