net.minecraftforge.fluids.capability.wrappers

Class BlockLiquidWrapper

java.lang.Object

net.minecraftforge.fluids.capability.wrappers.BlockLiquidWrapper

All Implemented Interfaces:

IFluidHandler

public class BlockLiquidWrapper
extends java.lang.Object
implements IFluidHandler

Wrapper to handle vanilla Water or Lava as an IFluidHandler. Methods are modeled after ItemBucket.onItemRightClick(World, EntityPlayer, EnumHand)

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockLiquid	blockLiquid
protected BlockPos	blockPos
protected World	world

Constructor Summary

Constructors

Constructor and Description
BlockLiquidWrapper(BlockLiquid blockLiquid, World world, BlockPos blockPos)

Method Summary

Modifier and Type	Method and Description
FluidStack	drain(FluidStack resource, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
FluidStack	drain(int maxDrain, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
int	fill(FluidStack resource, boolean doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
IFluidTankProperties[]	getTankProperties() Returns an array of objects which represent the internal tanks.

Methods inherited from class java.lang.Object

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

Field Detail

blockLiquid

protected final BlockLiquid blockLiquid

world

protected final World world

blockPos

protected final BlockPos blockPos

Constructor Detail

BlockLiquidWrapper

public BlockLiquidWrapper(BlockLiquid blockLiquid,
                          World world,
                          BlockPos blockPos)

Method Detail

getTankProperties

public IFluidTankProperties[] getTankProperties()

Description copied from interface: IFluidHandler

Returns an array of objects which represent the internal tanks. These objects cannot be used to manipulate the internal tanks.

Specified by:

getTankProperties in interface IFluidHandler

Returns:

Properties for the relevant internal tanks.

fill

public int fill(FluidStack resource,
                boolean doFill)

Description copied from interface: IFluidHandler

Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.

Specified by:

fill in interface IFluidHandler

Parameters:

resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.

doFill - If false, fill will only be simulated.

Returns:

Amount of resource that was (or would have been, if simulated) filled.

drain

@Nullable
public FluidStack drain(FluidStack resource,
                                   boolean doDrain)

Description copied from interface: IFluidHandler

Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.

Specified by:

drain in interface IFluidHandler

Parameters:

resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.

doDrain - If false, drain will only be simulated.

Returns:

FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.

drain

@Nullable
public FluidStack drain(int maxDrain,
                                   boolean doDrain)

Description copied from interface: IFluidHandler

Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.

This method is not Fluid-sensitive.

Specified by:

drain in interface IFluidHandler

Parameters:

maxDrain - Maximum amount of fluid to drain.

doDrain - If false, drain will only be simulated.

Returns:

FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.