Class FluidHandlerItemStack
java.lang.Object
net.minecraftforge.fluids.capability.templates.FluidHandlerItemStack
- All Implemented Interfaces:
ICapabilityProvider
,IFluidHandler
,IFluidHandlerItem
- Direct Known Subclasses:
FluidHandlerItemStack.Consumable
,FluidHandlerItemStack.SwapEmpty
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
Modifier and TypeClassDescriptionstatic class
Destroys the container item when it's emptied.static class
Swaps the container item for a different one when it's emptied.Nested classes/interfaces inherited from interface net.minecraftforge.fluids.capability.IFluidHandler
IFluidHandler.FluidAction
-
Field Summary
Modifier and TypeFieldDescriptionprotected int
protected @NotNull ItemStack
static final String
private final LazyOptional<IFluidHandlerItem>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canDrainFluidType
(FluidStack fluid) boolean
canFillFluidType
(FluidStack fluid) @NotNull FluidStack
drain
(int maxDrain, IFluidHandler.FluidAction action) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.@NotNull FluidStack
drain
(FluidStack resource, IFluidHandler.FluidAction action) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.int
fill
(FluidStack resource, IFluidHandler.FluidAction doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.<T> @NotNull LazyOptional<T>
getCapability
(@NotNull Capability<T> capability, @Nullable Direction facing) Retrieves the Optional handler for the capability requested on the specific side.@NotNull ItemStack
Get the container currently acted on by this fluid handler.@NotNull FluidStack
getFluid()
@NotNull FluidStack
getFluidInTank
(int tank) Returns the FluidStack in a given tank.int
getTankCapacity
(int tank) Retrieves the maximum fluid amount for a given tank.int
getTanks()
Returns the number of fluid storage units ("tanks") availableboolean
isFluidValid
(int tank, @NotNull FluidStack stack) This function is a way to determine which fluids can exist inside a given handler.protected void
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
Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider
getCapability
-
Field Details
-
FLUID_NBT_KEY
- See Also:
-
holder
-
container
-
capacity
protected int capacity
-
-
Constructor Details
-
FluidHandlerItemStack
- Parameters:
container
- The container itemStack, data is stored on it directly as NBT.capacity
- The maximum capacity of this fluid tank.
-
-
Method Details
-
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 interfaceIFluidHandlerItem
-
getFluid
-
setFluid
-
getTanks
public int getTanks()Description copied from interface:IFluidHandler
Returns the number of fluid storage units ("tanks") available- Specified by:
getTanks
in interfaceIFluidHandler
- Returns:
- The number of tanks available
-
getFluidInTank
Description copied from interface:IFluidHandler
Returns the FluidStack in a given tank.IMPORTANT: This FluidStack MUST NOT be modified. This method is not for altering internal contents. Any implementers who are able to detect modification via this method should throw an exception. It is ENTIRELY reasonable and likely that the stack returned here will be a copy.
SERIOUSLY: DO NOT MODIFY THE RETURNED FLUIDSTACK
- Specified by:
getFluidInTank
in interfaceIFluidHandler
- Parameters:
tank
- Tank to query.- Returns:
- FluidStack in a given tank. FluidStack.EMPTY if the tank is empty.
-
getTankCapacity
public int getTankCapacity(int tank) Description copied from interface:IFluidHandler
Retrieves the maximum fluid amount for a given tank.- Specified by:
getTankCapacity
in interfaceIFluidHandler
- Parameters:
tank
- Tank to query.- Returns:
- The maximum fluid amount held by the tank.
-
isFluidValid
Description copied from interface:IFluidHandler
This function is a way to determine which fluids can exist inside a given handler. General purpose tanks will basically always return TRUE for this.- Specified by:
isFluidValid
in interfaceIFluidHandler
- Parameters:
tank
- Tank to query for validitystack
- Stack to test with for validity- Returns:
- TRUE if the tank can hold the FluidStack, not considering current state. (Basically, is a given fluid EVER allowed in this tank?) Return FALSE if the answer to that question is 'no.'
-
fill
Description copied from interface:IFluidHandler
Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.- Specified by:
fill
in interfaceIFluidHandler
- Parameters:
resource
- FluidStack representing the Fluid and maximum amount of fluid to be filled.doFill
- If SIMULATE, fill will only be simulated.- Returns:
- Amount of resource that was (or would have been, if simulated) filled.
-
drain
Description copied from interface:IFluidHandler
Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.- Specified by:
drain
in interfaceIFluidHandler
- Parameters:
resource
- FluidStack representing the Fluid and maximum amount of fluid to be drained.action
- If SIMULATE, drain will only be simulated.- Returns:
- FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.
-
drain
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 interfaceIFluidHandler
- Parameters:
maxDrain
- Maximum amount of fluid to drain.action
- If SIMULATE, drain will only be simulated.- Returns:
- FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.
-
canFillFluidType
-
canDrainFluidType
-
setContainerToEmpty
protected void setContainerToEmpty()Override this method for special handling. Can be used to swap out or destroy the container. -
getCapability
@NotNull public <T> @NotNull LazyOptional<T> getCapability(@NotNull @NotNull Capability<T> capability, @Nullable @Nullable Direction facing) Description copied from interface:ICapabilityProvider
Retrieves the Optional handler for the capability requested on the specific side. The return value CAN be the same for multiple faces. Modders are encouraged to cache this value, using the listener capabilities of the Optional to be notified if the requested capability get lost.- Specified by:
getCapability
in interfaceICapabilityProvider
- Parameters:
capability
- The capability to checkfacing
- The Side to check from, CAN BE NULL. Null is defined to represent 'internal' or 'self'- Returns:
- The requested an optional holding the requested capability.
-