net.minecraftforge.fluids.capability.templates

Class FluidHandlerItemStack

java.lang.Object

net.minecraftforge.fluids.capability.templates.FluidHandlerItemStack

All Implemented Interfaces:

ICapabilityProvider, IFluidHandler, IFluidHandlerItem

Direct Known Subclasses:

FluidHandlerItemStack.Consumable, FluidHandlerItemStack.SwapEmpty

public class FluidHandlerItemStack
extends java.lang.Object
implements IFluidHandlerItem, ICapabilityProvider

FluidHandlerItemStack is a template capability provider for ItemStacks. Data is stored directly in the vanilla NBT, in the same way as the old ItemFluidContainer. This class allows an itemStack to contain any partial level of fluid up to its capacity, unlike FluidHandlerItemStackSimple Additional examples are provided to enable consumable fluid containers (see FluidHandlerItemStack.Consumable), fluid containers with different empty and full items (see FluidHandlerItemStack.SwapEmpty,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FluidHandlerItemStack.Consumable Destroys the container item when it's emptied.
static class	FluidHandlerItemStack.SwapEmpty Swaps the container item for a different one when it's emptied.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	capacity
protected ItemStack	container
static java.lang.String	FLUID_NBT_KEY

Constructor Summary

Constructors

Constructor and Description
FluidHandlerItemStack(ItemStack container, int capacity)

Method Summary

Modifier and Type	Method and Description
boolean	canDrainFluidType(FluidStack fluid)
boolean	canFillFluidType(FluidStack 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.
int	fill(FluidStack resource, boolean doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
<T> T	getCapability(Capability<T> capability, EnumFacing facing) Retrieves the handler for the capability requested on the specific side.
ItemStack	getContainer() Get the container currently acted on by this fluid handler.
FluidStack	getFluid()
IFluidTankProperties[]	getTankProperties() Returns an array of objects which represent the internal tanks.
boolean	hasCapability(Capability<?> capability, EnumFacing facing) Determines if this object has support for the capability in question on the specific side.
protected void	setContainerToEmpty() Override this method for special handling.
protected void	setFluid(FluidStack fluid)

Methods inherited from class java.lang.Object

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

Field Detail

FLUID_NBT_KEY

public static final java.lang.String FLUID_NBT_KEY

See Also:

Constant Field Values

container

@Nonnull
protected ItemStack container

capacity

protected int capacity

Constructor Detail

FluidHandlerItemStack

public FluidHandlerItemStack(@Nonnull
                             ItemStack container,
                             int capacity)

Parameters:

container - The container itemStack, data is stored on it directly as NBT.

capacity - The maximum capacity of this fluid tank.

Method Detail

getContainer

@Nonnull
public ItemStack getContainer()

Description copied from interface: IFluidHandlerItem

Get the container currently acted on by this fluid handler. The ItemStack may be different from its initial state, in the case of fluid containers that have different items for their filled and empty states. May be an empty item if the container was drained and is consumable.

Specified by:

getContainer in interface IFluidHandlerItem

getFluid

@Nullable
public FluidStack getFluid()

setFluid

protected void setFluid(FluidStack fluid)

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.

canFillFluidType

public boolean canFillFluidType(FluidStack fluid)

canDrainFluidType

public boolean canDrainFluidType(FluidStack fluid)

setContainerToEmpty

protected void setContainerToEmpty()

Override this method for special handling. Can be used to swap out or destroy the container.

hasCapability

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

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 loses support for a capability. It is not required to call this function before calling ICapabilityProvider.getCapability(Capability, EnumFacing).

Basically, this method functions analogously to Map.containsKey(Object).

Example: A Pipe getting a cover placed on one side causing it lose 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. If true, then ICapabilityProvider.getCapability(Capability, EnumFacing) must not return null.

getCapability

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

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.

Basically, this method functions analogously to Map.get(Object).

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:

The requested capability. Must NOT be null when ICapabilityProvider.hasCapability(Capability, EnumFacing) would return true.