Package alexiil.mc.lib.attributes.fluid

Class FluidVolumeUtil.FluidTankInteraction

java.lang.Object

alexiil.mc.lib.attributes.fluid.FluidVolumeUtil.FluidTankInteraction

Enclosing class:

FluidVolumeUtil

public static final class FluidVolumeUtil.FluidTankInteraction
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
FluidVolume	fluidMoved	A copy of the fluid moved.
FluidVolumeUtil.ItemContainerStatus	fromTankStatus
boolean	intoTank	If true then the interaction drained fluid from the ItemStack, and inserted it into the FluidInsertable tank.
FluidVolumeUtil.ItemContainerStatus	intoTankStatus	The status of the FluidExtractable obtained from the ItemStack, via
static FluidVolumeUtil.FluidTankInteraction	NONE

Constructor Summary

Constructors

Constructor	Description
FluidTankInteraction(FluidVolume fluidMoved, boolean intoTank)	Deprecated, for removal: This API element is subject to removal in a future version.
FluidTankInteraction(FluidVolume fluidMoved, boolean intoTank, FluidVolumeUtil.ItemContainerStatus intoTankStatus, FluidVolumeUtil.ItemContainerStatus fromTankStatus)	Constructs a new FluidVolumeUtil.FluidTankInteraction object.

Method Summary

Modifier and Type	Method	Description
int	amountMoved()	Deprecated, for removal: This API element is subject to removal in a future version.
FluidAmount	amountMoved_F()
net.minecraft.util.ActionResult	asActionResult()	Converts this interaction result into a vanilla minecraft ActionResult, suitable for normal block or item "use" methods.
boolean	didCheckItemStack()
boolean	didMoveAny()	Checks to see if any fluid was moved in the interaction.
static FluidVolumeUtil.FluidTankInteraction	fromTank(FluidVolume fluid)	Deprecated, for removal: This API element is subject to removal in a future version.
static FluidVolumeUtil.FluidTankInteraction	intoTank(FluidVolume fluid)	Deprecated, for removal: This API element is subject to removal in a future version.
static FluidVolumeUtil.FluidTankInteraction	none(FluidVolumeUtil.ItemContainerStatus intoTankStatus, FluidVolumeUtil.ItemContainerStatus fromTankStatus)
boolean	wasContainerValid()

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final FluidVolumeUtil.FluidTankInteraction NONE

fluidMoved

public final FluidVolume fluidMoved

A copy of the fluid moved.

intoTank

public final boolean intoTank

If true then the interaction drained fluid from the ItemStack, and inserted it into the FluidInsertable tank. Otherwise this will be false.

intoTankStatus

public final FluidVolumeUtil.ItemContainerStatus intoTankStatus

The status of the FluidExtractable obtained from the ItemStack, via

fromTankStatus

public final FluidVolumeUtil.ItemContainerStatus fromTankStatus

Constructor Details

FluidTankInteraction

@Deprecated(since="0.6.4",
            forRemoval=true)
public FluidTankInteraction(FluidVolume fluidMoved,
 boolean intoTank)

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

FluidTankInteraction

public FluidTankInteraction(FluidVolume fluidMoved,
 boolean intoTank,
 FluidVolumeUtil.ItemContainerStatus intoTankStatus,
 FluidVolumeUtil.ItemContainerStatus fromTankStatus)

Constructs a new FluidVolumeUtil.FluidTankInteraction object.

Generally it is not expected that this be called by any method other than FluidInvUtil.interactItemWithTank(FluidInsertable, FluidExtractable, Reference, LimitedConsumer, FluidAmount)

Method Details

intoTank

@Deprecated(since="0.6.4",
            forRemoval=true)
public static FluidVolumeUtil.FluidTankInteraction intoTank(FluidVolume fluid)

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

fromTank

@Deprecated(since="0.6.4",
            forRemoval=true)
public static FluidVolumeUtil.FluidTankInteraction fromTank(FluidVolume fluid)

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

none

public static FluidVolumeUtil.FluidTankInteraction none(FluidVolumeUtil.ItemContainerStatus intoTankStatus,
 FluidVolumeUtil.ItemContainerStatus fromTankStatus)

didMoveAny

public boolean didMoveAny()

Checks to see if any fluid was moved in the interaction.

Returns:

The inverse of fluidMoved.isEmpty()

wasContainerValid

public boolean wasContainerValid()

Returns:

true if either of intoTankStatus or fromTankStatus is #VALID.

didCheckItemStack

public boolean didCheckItemStack()

Returns:

true if either of intoTankStatus or fromTankStatus is different to FluidVolumeUtil.ItemContainerStatus.NOT_CHECKED.

asActionResult

public net.minecraft.util.ActionResult asActionResult()

Converts this interaction result into a vanilla minecraft ActionResult, suitable for normal block or item "use" methods.

Returns:

1. ActionResult.SUCCESS if didMoveAny() returns true.
2. ActionResult.FAIL if wasContainerValid() returns true.
3. ActionResult.PASS otherwise.

(This is based on the principle that attempting to use an empty bucket on an empty tank should return ActionResult.FAIL, but using an unrelated item - such as an iron ingot - should return ActionResult.PASS)

amountMoved

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

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

amountMoved_F

public FluidAmount amountMoved_F()