net.minecraftforge.fluids

Class TileFluidHandler

java.lang.Object

net.minecraft.tileentity.TileEntity

net.minecraftforge.fluids.TileFluidHandler

All Implemented Interfaces:

ICapabilityProvider, ICapabilitySerializable<NBTTagCompound>, INBTSerializable<NBTTagCompound>, IFluidHandler

public class TileFluidHandler
extends TileEntity
implements IFluidHandler

Reference Tile Entity implementation of IFluidHandler. Use/extend this or write your own.

Field Summary

Fields

Modifier and Type	Field and Description
protected FluidTank	tank

Fields inherited from class net.minecraft.tileentity.TileEntity

blockType, INFINITE_EXTENT_AABB, pos, tileEntityInvalid, worldObj

Constructor Summary

Constructors

Constructor and Description
TileFluidHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canDrain(EnumFacing from, Fluid fluid) Returns true if the given fluid can be extracted from the given direction.
boolean	canFill(EnumFacing from, Fluid fluid) Returns true if the given fluid can be inserted into the given direction.
FluidStack	drain(EnumFacing from, FluidStack resource, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
FluidStack	drain(EnumFacing from, int maxDrain, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
int	fill(EnumFacing from, FluidStack resource, boolean doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
FluidTankInfo[]	getTankInfo(EnumFacing from) Returns an array of objects which represent the internal tanks.
void	readFromNBT(NBTTagCompound tag)
NBTTagCompound	writeToNBT(NBTTagCompound tag)

Methods inherited from class net.minecraft.tileentity.TileEntity

addInfoToCrashReport, addMapping, canRenderBreaking, create, deserializeNBT, getBlockMetadata, getBlockType, getCapability, getDistanceSq, getMaxRenderDistanceSquared, getPos, getRenderBoundingBox, getTileData, getUpdatePacket, getUpdateTag, getWorld, handleUpdateTag, hasCapability, hasFastRenderer, hasWorldObj, invalidate, isInvalid, markDirty, onChunkUnload, onDataPacket, onLoad, onlyOpsCanSetNbt, receiveClientEvent, restrictNBTCopy, serializeNBT, setPos, setWorldObj, shouldRefresh, shouldRenderInPass, updateContainingBlockInfo, validate

Methods inherited from class java.lang.Object

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

Field Detail

tank

protected FluidTank tank

Constructor Detail

TileFluidHandler

public TileFluidHandler()

Method Detail

readFromNBT

public void readFromNBT(NBTTagCompound tag)

Overrides:

readFromNBT in class TileEntity

writeToNBT

public NBTTagCompound writeToNBT(NBTTagCompound tag)

Overrides:

writeToNBT in class TileEntity

fill

public int fill(EnumFacing from,
                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:

from - Orientation the Fluid is pumped in from.

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(EnumFacing from,
                        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:

from - Orientation the Fluid is drained to.

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(EnumFacing from,
                        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:

from - Orientation the fluid is drained to.

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.

canFill

public boolean canFill(EnumFacing from,
                       Fluid fluid)

Description copied from interface: IFluidHandler

Returns true if the given fluid can be inserted into the given direction. More formally, this should return true if fluid is able to enter from the given direction.

Specified by:

canFill in interface IFluidHandler

canDrain

public boolean canDrain(EnumFacing from,
                        Fluid fluid)

Description copied from interface: IFluidHandler

Returns true if the given fluid can be extracted from the given direction. More formally, this should return true if fluid is able to leave from the given direction.

Specified by:

canDrain in interface IFluidHandler

getTankInfo

public FluidTankInfo[] getTankInfo(EnumFacing from)

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. See FluidTankInfo.

Specified by:

getTankInfo in interface IFluidHandler

Parameters:

from - Orientation determining which tanks should be queried.

Returns:

Info for the relevant internal tanks.