net.minecraftforge.fluids.capability

Interface IFluidHandler

All Known Subinterfaces:

IFluidHandlerItem

All Known Implementing Classes:

BlockLiquidWrapper, BlockWrapper, EmptyFluidHandler, FluidBlockWrapper, FluidBucketWrapper, FluidHandlerConcatenate, FluidHandlerFluidMap, FluidHandlerItemStack, FluidHandlerItemStack.Consumable, FluidHandlerItemStack.SwapEmpty, FluidHandlerItemStackSimple, FluidHandlerItemStackSimple.Consumable, FluidHandlerItemStackSimple.SwapEmpty, FluidTank, VoidFluidHandler

public interface IFluidHandler

Implement this interface as a capability which should handle fluids, generally storing them in one or more internal IFluidTank objects.

A reference implementation is provided TileFluidHandler.

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.

Method Detail

getTankProperties

IFluidTankProperties[] getTankProperties()

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

Returns:

Properties for the relevant internal tanks.

fill

int fill(FluidStack resource,
         boolean doFill)

Fills fluid into internal tanks, distribution is left entirely to the 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
FluidStack drain(FluidStack resource,
                            boolean doDrain)

Drains fluid out of internal tanks, distribution is left entirely to the 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
FluidStack drain(int maxDrain,
                            boolean doDrain)

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

This method is not Fluid-sensitive.

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.