Class FluidStack


public class FluidStack extends Object
ItemStack substitute for Fluids. NOTE: Equality is based on the Fluid, not the amount. Use isFluidStackIdentical(FluidStack) to determine if FluidID, Amount and NBT Tag are all equal.
  • Field Details

    • LOGGER

      private static final org.apache.logging.log4j.Logger LOGGER
    • EMPTY

      public static final FluidStack EMPTY
    • CODEC

      public static final com.mojang.serialization.Codec<FluidStack> CODEC
    • isEmpty

      private boolean isEmpty
    • amount

      private int amount
    • tag

      private CompoundNBT tag
    • fluidDelegate

      private IRegistryDelegate<Fluid> fluidDelegate
  • Constructor Details

    • FluidStack

      public FluidStack(Fluid fluid, int amount)
    • FluidStack

      public FluidStack(Fluid fluid, int amount, CompoundNBT nbt)
    • FluidStack

      public FluidStack(FluidStack stack, int amount)
  • Method Details

    • loadFluidStackFromNBT

      public static FluidStack loadFluidStackFromNBT(CompoundNBT nbt)
      This provides a safe method for retrieving a FluidStack - if the Fluid is invalid, the stack will return as null.
    • writeToNBT

      public CompoundNBT writeToNBT(CompoundNBT nbt)
    • writeToPacket

      public void writeToPacket(PacketBuffer buf)
    • readFromPacket

      public static FluidStack readFromPacket(PacketBuffer buf)
    • getFluid

      public final Fluid getFluid()
    • getRawFluid

      public final Fluid getRawFluid()
    • isEmpty

      public boolean isEmpty()
    • updateEmpty

      protected void updateEmpty()
    • getAmount

      public int getAmount()
    • setAmount

      public void setAmount(int amount)
    • grow

      public void grow(int amount)
    • shrink

      public void shrink(int amount)
    • hasTag

      public boolean hasTag()
    • getTag

      public CompoundNBT getTag()
    • setTag

      public void setTag(CompoundNBT tag)
    • getOrCreateTag

      public CompoundNBT getOrCreateTag()
    • getChildTag

      public CompoundNBT getChildTag(String childName)
    • getOrCreateChildTag

      public CompoundNBT getOrCreateChildTag(String childName)
    • removeChildTag

      public void removeChildTag(String childName)
    • getDisplayName

      public ITextComponent getDisplayName()
    • getTranslationKey

      public String getTranslationKey()
    • copy

      public FluidStack copy()
      A copy of this FluidStack
    • isFluidEqual

      public boolean isFluidEqual(@Nonnull FluidStack other)
      Determines if the FluidIDs and NBT Tags are equal. This does not check amounts.
      other - The FluidStack for comparison
      true if the Fluids (IDs and NBT Tags) are the same
    • isFluidStackTagEqual

      private boolean isFluidStackTagEqual(FluidStack other)
    • areFluidStackTagsEqual

      public static boolean areFluidStackTagsEqual(@Nonnull FluidStack stack1, @Nonnull FluidStack stack2)
      Determines if the NBT Tags are equal. Useful if the FluidIDs are known to be equal.
    • containsFluid

      public boolean containsFluid(@Nonnull FluidStack other)
      Determines if the Fluids are equal and this stack is larger.
      other -
      true if this FluidStack contains the other FluidStack (same fluid and >= amount)
    • isFluidStackIdentical

      public boolean isFluidStackIdentical(FluidStack other)
      Determines if the FluidIDs, Amounts, and NBT Tags are all equal.
      other - - the FluidStack for comparison
      true if the two FluidStacks are exactly the same
    • isFluidEqual

      public boolean isFluidEqual(@Nonnull ItemStack other)
      Determines if the FluidIDs and NBT Tags are equal compared to a registered container ItemStack. This does not check amounts.
      other - The ItemStack for comparison
      true if the Fluids (IDs and NBT Tags) are the same
    • hashCode

      public final int hashCode()
      hashCode in class Object
    • equals

      public final boolean equals(Object o)
      Default equality comparison for a FluidStack. Same functionality as isFluidEqual(). This is included for use in data structures.
      equals in class Object