net.minecraftforge.fluids.capability.templates

Class VoidFluidHandler

java.lang.Object

net.minecraftforge.fluids.capability.templates.VoidFluidHandler

All Implemented Interfaces:

IFluidHandler, IFluidTank

Direct Known Subclasses:

BlockWrapper

public class VoidFluidHandler
extends java.lang.Object
implements IFluidHandler, IFluidTank

VoidFluidHandler is a template fluid handler that can be filled indefinitely without ever getting full. It does not store fluid that gets filled into it, but "destroys" it upon receiving it.

Field Summary

Fields

Modifier and Type	Field and Description
static EmptyFluidHandler	INSTANCE

Constructor Summary

Constructors

Constructor and Description
VoidFluidHandler()

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.
int	getCapacity()
FluidStack	getFluid()
int	getFluidAmount()
FluidTankInfo	getInfo() Returns a wrapper object FluidTankInfo containing the capacity of the tank and the FluidStack it holds.
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

INSTANCE

public static final EmptyFluidHandler INSTANCE

Constructor Detail

VoidFluidHandler

public VoidFluidHandler()

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.

getFluid

public FluidStack getFluid()

Specified by:

getFluid in interface IFluidTank

Returns:

FluidStack representing the fluid in the tank, null if the tank is empty.

getFluidAmount

public int getFluidAmount()

Specified by:

getFluidAmount in interface IFluidTank

Returns:

Current amount of fluid in the tank.

getCapacity

public int getCapacity()

Specified by:

getCapacity in interface IFluidTank

Returns:

Capacity of this fluid tank.

getInfo

public FluidTankInfo getInfo()

Description copied from interface: IFluidTank

Returns a wrapper object FluidTankInfo containing the capacity of the tank and the FluidStack it holds. Should prevent manipulation of the IFluidTank. See FluidTank.

Specified by:

getInfo in interface IFluidTank

Returns:

State information for the IFluidTank.

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

Specified by:

fill in interface IFluidTank

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

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

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

Specified by:

drain in interface IFluidTank

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.