net.minecraftforge.fluids.capability.wrappers

Class FluidContainerItemWrapper

java.lang.Object

net.minecraftforge.fluids.capability.wrappers.FluidContainerItemWrapper

All Implemented Interfaces:

ICapabilityProvider, IFluidHandler

Deprecated.

will be removed along with IFluidContainerItem

@Deprecated
public class FluidContainerItemWrapper
extends java.lang.Object
implements IFluidHandler, ICapabilityProvider

FluidContainerItemWrapper converts an old IFluidContainerItem to IFluidHandler. Note that successful operations WILL modify the container itemStack.

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemStack	container Deprecated.
protected IFluidContainerItem	handler Deprecated.

Constructor Summary

Constructors

Constructor and Description
FluidContainerItemWrapper(IFluidContainerItem handler, ItemStack container) Deprecated.

Method Summary

Modifier and Type	Method and Description
FluidStack	drain(FluidStack resource, boolean doDrain) Deprecated. Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
FluidStack	drain(int maxDrain, boolean doDrain) Deprecated. Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
int	fill(FluidStack resource, boolean doFill) Deprecated. Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
<T> T	getCapability(Capability<T> capability, EnumFacing facing) Deprecated. Retrieves the handler for the capability requested on the specific side.
FluidTankProperties[]	getTankProperties() Deprecated. Returns an array of objects which represent the internal tanks.
boolean	hasCapability(Capability<?> capability, EnumFacing facing) Deprecated. Determines if this object has support for the capability in question on the specific side.

Methods inherited from class java.lang.Object

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

Field Detail

handler

protected final IFluidContainerItem handler

Deprecated.

container

protected final ItemStack container

Deprecated.

Constructor Detail

FluidContainerItemWrapper

public FluidContainerItemWrapper(IFluidContainerItem handler,
                                 ItemStack container)

Deprecated.

Method Detail

getTankProperties

public FluidTankProperties[] getTankProperties()

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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.

hasCapability

public boolean hasCapability(Capability<?> capability,
                             EnumFacing facing)

Deprecated.

Description copied from interface: ICapabilityProvider

Determines if this object has support for the capability in question on the specific side. The return value of this MIGHT change during runtime if this object gains or looses support for a capability. Example: A Pipe getting a cover placed on one side causing it loose the Inventory attachment function for that side. This is a light weight version of getCapability, intended for metadata uses.

Specified by:

hasCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

True if this object supports the capability.

getCapability

public <T> T getCapability(Capability<T> capability,
                           EnumFacing facing)

Deprecated.

Description copied from interface: ICapabilityProvider

Retrieves the handler for the capability requested on the specific side. The return value CAN be null if the object does not support the capability. The return value CAN be the same for multiple faces.

Specified by:

getCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

True if this object supports the capability.