Package net.neoforged.neoforge.fluids.capability.wrappers

Class FluidBucketWrapper

java.lang.Object
net.neoforged.neoforge.fluids.capability.wrappers.FluidBucketWrapper
All Implemented Interfaces:
IFluidHandler, IFluidHandlerItem
@Deprecated(since="1.21.9", forRemoval=true) public class FluidBucketWrapper extends Object implements IFluidHandlerItem
Deprecated, for removal: This API element is subject to removal in a future version.
Use BucketResourceHandler instead.
Wrapper for vanilla and forge buckets. Swaps between empty bucket and filled bucket of the correct type.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.neoforged.neoforge.fluids.capability.IFluidHandler

    IFluidHandler.FluidAction

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ItemStack
    container
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FluidBucketWrapper(ItemStack container)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canFillFluidType(FluidStack fluid)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FluidStack
    drain(int maxDrain, IFluidHandler.FluidAction action)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
    FluidStack
    drain(FluidStack resource, IFluidHandler.FluidAction action)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
    int
    fill(FluidStack resource, IFluidHandler.FluidAction action)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
    ItemStack
    getContainer()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the container currently acted on by this fluid handler.
    FluidStack
    getFluid()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FluidStack
    getFluidInTank(int tank)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the FluidStack in a given tank.
    int
    getTankCapacity(int tank)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves the maximum fluid amount for a given tank.
    int
    getTanks()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the number of fluid storage units ("tanks") available
    boolean
    isFluidValid(int tank, FluidStack stack)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This function is a way to determine which fluids can exist inside a given handler.
    protected void
    setFluid(FluidStack fluidStack)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • container

      protected ItemStack container
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • FluidBucketWrapper

      public FluidBucketWrapper(ItemStack container)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getContainer

      public ItemStack getContainer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • canFillFluidType

      public boolean canFillFluidType(FluidStack fluid)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getFluid

      public FluidStack getFluid()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setFluid

      protected void setFluid(FluidStack fluidStack)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTanks

      public int getTanks()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IFluidHandler
      Returns the number of fluid storage units ("tanks") available
      Specified by:
      getTanks in interface IFluidHandler
      Returns:
      The number of tanks available

    • getFluidInTank

      public FluidStack getFluidInTank(int tank)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 interface IFluidHandler
      Parameters:
      tank - Tank to query.
      Returns:
      FluidStack in a given tank. FluidStack.EMPTY if the tank is empty.

    • getTankCapacity

      public int getTankCapacity(int tank)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IFluidHandler
      Retrieves the maximum fluid amount for a given tank.
      Specified by:
      getTankCapacity in interface IFluidHandler
      Parameters:
      tank - Tank to query.
      Returns:
      The maximum fluid amount held by the tank.

    • isFluidValid

      public boolean isFluidValid(int tank, FluidStack stack)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 interface IFluidHandler
      Parameters:
      tank - Tank to query for validity
      stack - 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

      public int fill(FluidStack resource, IFluidHandler.FluidAction action)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      action - If SIMULATE, fill will only be simulated.
      Returns:
      Amount of resource that was (or would have been, if simulated) filled.

    • drain

      public FluidStack drain(FluidStack resource, IFluidHandler.FluidAction action)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      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

      public FluidStack drain(int maxDrain, IFluidHandler.FluidAction action)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      action - If SIMULATE, drain will only be simulated.
      Returns:
      FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.