net.minecraftforge.fluids

Class FluidTank

java.lang.Object

net.minecraftforge.fluids.FluidTank

All Implemented Interfaces:

IFluidHandler, IFluidTank

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

Reference implementation of IFluidTank. Use/extend this or implement your own.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canDrain
protected boolean	canFill
protected int	capacity
protected FluidStack	fluid
protected IFluidTankProperties[]	tankProperties
protected TileEntity	tile

Constructor Summary

Constructors

Constructor and Description
FluidTank(Fluid fluid, int amount, int capacity)
FluidTank(FluidStack fluidStack, int capacity)
FluidTank(int capacity)

Method Summary

Modifier and Type	Method and Description
boolean	canDrain() Whether this tank can be drained with IFluidHandler
boolean	canDrainFluidType(FluidStack fluid) Returns true if the tank can drain out this type of fluid.
boolean	canFill() Whether this tank can be filled with IFluidHandler
boolean	canFillFluidType(FluidStack fluid) Returns true if the tank can be filled with this type of fluid.
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.
FluidStack	drainInternal(FluidStack resource, boolean doDrain) Use this method to bypass the restrictions from canDrainFluidType(FluidStack) Meant for use by the owner of the tank when they have canDrain() set to false}.
FluidStack	drainInternal(int maxDrain, boolean doDrain) Use this method to bypass the restrictions from canDrainFluidType(FluidStack) Meant for use by the owner of the tank when they have canDrain() set to false}.
int	fill(FluidStack resource, boolean doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
int	fillInternal(FluidStack resource, boolean doFill) Use this method to bypass the restrictions from canFillFluidType(FluidStack) Meant for use by the owner of the tank when they have set to false.
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.
protected void	onContentsChanged()
FluidTank	readFromNBT(NBTTagCompound nbt)
void	setCanDrain(boolean canDrain) Set whether this tank can be drained with IFluidHandler
void	setCanFill(boolean canFill) Set whether this tank can be filled with IFluidHandler
void	setCapacity(int capacity)
void	setFluid(FluidStack fluid)
void	setTileEntity(TileEntity tile)
NBTTagCompound	writeToNBT(NBTTagCompound nbt)

Methods inherited from class java.lang.Object

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

Field Detail

fluid

@Nullable
protected FluidStack fluid

capacity

protected int capacity

tile

protected TileEntity tile

canFill

protected boolean canFill

canDrain

protected boolean canDrain

tankProperties

protected IFluidTankProperties[] tankProperties

Constructor Detail

FluidTank

public FluidTank(int capacity)

FluidTank

public FluidTank(@Nullable
                 FluidStack fluidStack,
                 int capacity)

FluidTank

public FluidTank(Fluid fluid,
                 int amount,
                 int capacity)

Method Detail

readFromNBT

public FluidTank readFromNBT(NBTTagCompound nbt)

writeToNBT

public NBTTagCompound writeToNBT(NBTTagCompound nbt)

getFluid

@Nullable
public FluidStack getFluid()

Specified by:

getFluid in interface IFluidTank

Returns:

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

setFluid

public void setFluid(@Nullable
                     FluidStack fluid)

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.

setCapacity

public void setCapacity(int capacity)

setTileEntity

public void setTileEntity(TileEntity tile)

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.

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

Specified by:

fill in interface IFluidTank

Parameters:

resource - FluidStack attempting to fill the tank.

doFill - If false, the fill will only be simulated.

Returns:

Amount of fluid that was accepted by the tank.

fillInternal

public int fillInternal(FluidStack resource,
                        boolean doFill)

Use this method to bypass the restrictions from canFillFluidType(FluidStack) Meant for use by the owner of the tank when they have set to false.

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 be removed from the container.

doDrain - If false, the drain will only be simulated.

Returns:

Amount of fluid that was removed from the tank.

drainInternal

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

Use this method to bypass the restrictions from canDrainFluidType(FluidStack) Meant for use by the owner of the tank when they have canDrain() set to false}.

drainInternal

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

Use this method to bypass the restrictions from canDrainFluidType(FluidStack) Meant for use by the owner of the tank when they have canDrain() set to false}.

canFill

public boolean canFill()

Whether this tank can be filled with IFluidHandler

See Also:

IFluidTankProperties.canFill()

canDrain

public boolean canDrain()

Whether this tank can be drained with IFluidHandler

See Also:

IFluidTankProperties.canDrain()

setCanFill

public void setCanFill(boolean canFill)

Set whether this tank can be filled with IFluidHandler

See Also:

IFluidTankProperties.canFill()

setCanDrain

public void setCanDrain(boolean canDrain)

Set whether this tank can be drained with IFluidHandler

See Also:

IFluidTankProperties.canDrain()

canFillFluidType

public boolean canFillFluidType(FluidStack fluid)

Returns true if the tank can be filled with this type of fluid. Used as a filter for fluid types. Does not consider the current contents or capacity of the tank, only whether it could ever fill with this type of fluid.

See Also:

IFluidTankProperties.canFillFluidType(FluidStack)

canDrainFluidType

public boolean canDrainFluidType(@Nullable
                                 FluidStack fluid)

Returns true if the tank can drain out this type of fluid. Used as a filter for fluid types. Does not consider the current contents or capacity of the tank, only whether it could ever drain out this type of fluid.

See Also:

IFluidTankProperties.canDrainFluidType(FluidStack)

onContentsChanged

protected void onContentsChanged()