net.minecraftforge.fluids.capability.templates

Class FluidHandlerConcatenate

java.lang.Object

net.minecraftforge.fluids.capability.templates.FluidHandlerConcatenate

All Implemented Interfaces:

IFluidHandler

public class FluidHandlerConcatenate
extends java.lang.Object
implements IFluidHandler

FluidHandlerConcatenate is a template class for concatenating multiple handlers into one. If each tank is restricted to exactly one type of fluid, then use FluidHandlerFluidMap as it is more efficient.

Field Summary

Fields

Modifier and Type	Field and Description
protected IFluidHandler[]	subHandlers

Constructor Summary

Constructors

Constructor and Description
FluidHandlerConcatenate(java.util.Collection<IFluidHandler> subHandlers)
FluidHandlerConcatenate(IFluidHandler... subHandlers)

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

subHandlers

protected final IFluidHandler[] subHandlers

Constructor Detail

FluidHandlerConcatenate

public FluidHandlerConcatenate(IFluidHandler... subHandlers)

FluidHandlerConcatenate

public FluidHandlerConcatenate(java.util.Collection<IFluidHandler> subHandlers)

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

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

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.