Package org.cyclops.cyclopscore.helper

Class FluidHelpersNeoForge

java.lang.Object
org.cyclops.cyclopscore.helper.FluidHelpersNeoForge
All Implemented Interfaces:
IFluidHelpersNeoForge
public class FluidHelpersNeoForge extends Object implements IFluidHelpersNeoForge

  • Constructor Summary

    Constructors
    Constructor
    Description
    FluidHelpersNeoForge()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canExtract(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
    If something can be extracted from the given handler.
    boolean
    canInsert(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler, net.neoforged.neoforge.fluids.FluidStack fluidStack)
    If at least a part of the given fluid stack can be inserted into the given handler.
    net.neoforged.neoforge.fluids.FluidStack
    copy(net.neoforged.neoforge.fluids.FluidStack fluidStack)
    Copy the given fluid stack
    net.neoforged.neoforge.fluids.FluidStack
    extractFromInventory(int amount, @Nullable net.minecraft.world.item.ItemStack blacklistedStack, @Nullable net.minecraft.world.level.material.Fluid fluidWhitelist, net.minecraft.world.entity.player.Player player, net.neoforged.neoforge.transfer.transaction.Transaction transaction)
    Extract the given fluid amount from any item inside the player's inventory.
    net.neoforged.neoforge.fluids.FluidStack
    extractFromItemOrInventory(int amount, net.minecraft.world.item.ItemStack itemStack, @Nullable net.minecraft.world.entity.player.Player player, net.neoforged.neoforge.transfer.transaction.Transaction transaction)
    Extract the given fluid amount from the given item, or from the player's inventory if that fails.
    int
    getAmount(net.neoforged.neoforge.fluids.FluidStack fluidStack)
    Get the fluid amount of the given stack in a safe manner.
    int
    getBucketVolume()
     
    long
    getCapacity(@Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
    Get the capacity of a fluid handler.
    net.neoforged.neoforge.fluids.FluidStack
    getFluid(@Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
    Get the fluid contained in a fluid handler.
    Optional<IFluidHandlerCapacity>
    getFluidHandlerItemCapacity(net.neoforged.neoforge.transfer.access.ItemAccess itemAccess)
     
    boolean
    hasFluid(@Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
    Check if the fluid handler is not empty.
    net.neoforged.neoforge.fluids.FluidStack
    move(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> source, net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> destination, int maxAmount, @Nullable net.minecraft.world.entity.player.Player player, boolean emptySound, boolean simulate)
    Move fluids from the given source and destination.
    net.neoforged.neoforge.fluids.FluidStack
    placeOrPickUpFluid(net.minecraft.world.entity.player.Player player, net.minecraft.world.InteractionHand hand, net.minecraft.world.level.Level world, net.minecraft.core.BlockPos blockPos, net.minecraft.core.Direction side)
    Try placing or picking up fluids from the held item.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FluidHelpersNeoForge

      public FluidHelpersNeoForge()

  • Method Details

    • getBucketVolume

      public int getBucketVolume()
      Specified by:
      getBucketVolume in interface IFluidHelpersNeoForge

    • getAmount

      public int getAmount(net.neoforged.neoforge.fluids.FluidStack fluidStack)
      Description copied from interface: IFluidHelpersNeoForge
      Get the fluid amount of the given stack in a safe manner.
      Specified by:
      getAmount in interface IFluidHelpersNeoForge
      Parameters:
      fluidStack - The fluid stack
      Returns:
      The fluid amount.

    • copy

      public net.neoforged.neoforge.fluids.FluidStack copy(net.neoforged.neoforge.fluids.FluidStack fluidStack)
      Description copied from interface: IFluidHelpersNeoForge
      Copy the given fluid stack
      Specified by:
      copy in interface IFluidHelpersNeoForge
      Parameters:
      fluidStack - The fluid stack to copy.
      Returns:
      A copy of the fluid stack.

    • getFluid

      public net.neoforged.neoforge.fluids.FluidStack getFluid(@Nullable @Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
      Description copied from interface: IFluidHelpersNeoForge
      Get the fluid contained in a fluid handler.
      Specified by:
      getFluid in interface IFluidHelpersNeoForge
      Parameters:
      fluidHandler - The fluid handler.
      Returns:
      The fluid.

    • hasFluid

      public boolean hasFluid(@Nullable @Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
      Description copied from interface: IFluidHelpersNeoForge
      Check if the fluid handler is not empty.
      Specified by:
      hasFluid in interface IFluidHelpersNeoForge
      Parameters:
      fluidHandler - The fluid handler.
      Returns:
      If it is not empty.

    • getCapacity

      public long getCapacity(@Nullable @Nullable net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
      Description copied from interface: IFluidHelpersNeoForge
      Get the capacity of a fluid handler.
      Specified by:
      getCapacity in interface IFluidHelpersNeoForge
      Parameters:
      fluidHandler - The fluid handler.
      Returns:
      The capacity.

    • getFluidHandlerItemCapacity

      public Optional<IFluidHandlerCapacity> getFluidHandlerItemCapacity(net.neoforged.neoforge.transfer.access.ItemAccess itemAccess)
      Specified by:
      getFluidHandlerItemCapacity in interface IFluidHelpersNeoForge
      Parameters:
      itemAccess - The item access
      Returns:
      The item capacity fluid handler.

    • extractFromInventory

      public net.neoforged.neoforge.fluids.FluidStack extractFromInventory(int amount, @Nullable @Nullable net.minecraft.world.item.ItemStack blacklistedStack, @Nullable @Nullable net.minecraft.world.level.material.Fluid fluidWhitelist, net.minecraft.world.entity.player.Player player, net.neoforged.neoforge.transfer.transaction.Transaction transaction)
      Description copied from interface: IFluidHelpersNeoForge
      Extract the given fluid amount from any item inside the player's inventory.
      Specified by:
      extractFromInventory in interface IFluidHelpersNeoForge
      Parameters:
      amount - A fluid amount to extract.
      blacklistedStack - The itemstack to skip. Useful if this is the stack that you are inserting to.
      fluidWhitelist - A fluid to transfer, can be null to allow any fluid to be transferred.
      player - The player to scan the inventory from.
      transaction - The transaction.
      Returns:
      The extracted fluidstack.

    • extractFromItemOrInventory

      public net.neoforged.neoforge.fluids.FluidStack extractFromItemOrInventory(int amount, net.minecraft.world.item.ItemStack itemStack, @Nullable @Nullable net.minecraft.world.entity.player.Player player, net.neoforged.neoforge.transfer.transaction.Transaction transaction)
      Description copied from interface: IFluidHelpersNeoForge
      Extract the given fluid amount from the given item, or from the player's inventory if that fails.
      Specified by:
      extractFromItemOrInventory in interface IFluidHelpersNeoForge
      Parameters:
      amount - A fluid amount to extract.
      itemStack - The item to extract from first.
      player - The player to scan the inventory from.
      transaction - The transaction.
      Returns:
      The extracted fluidstack.

    • placeOrPickUpFluid

      public net.neoforged.neoforge.fluids.FluidStack placeOrPickUpFluid(net.minecraft.world.entity.player.Player player, net.minecraft.world.InteractionHand hand, net.minecraft.world.level.Level world, net.minecraft.core.BlockPos blockPos, net.minecraft.core.Direction side)
      Description copied from interface: IFluidHelpersNeoForge
      Try placing or picking up fluids from the held item. This can be called in Item.use(net.minecraft.world.level.Level, net.minecraft.world.entity.player.Player, net.minecraft.world.InteractionHand).
      Specified by:
      placeOrPickUpFluid in interface IFluidHelpersNeoForge
      Parameters:
      player - The active player.
      hand - The active hand.
      world - The world.
      blockPos - The target position.
      side - The target side.
      Returns:
      The moved fluid.

    • canExtract

      public boolean canExtract(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler)
      Description copied from interface: IFluidHelpersNeoForge
      If something can be extracted from the given handler.
      Specified by:
      canExtract in interface IFluidHelpersNeoForge
      Parameters:
      fluidHandler - A fluid handler.
      Returns:
      If something can be extracted.

    • canInsert

      public boolean canInsert(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> fluidHandler, net.neoforged.neoforge.fluids.FluidStack fluidStack)
      Description copied from interface: IFluidHelpersNeoForge
      If at least a part of the given fluid stack can be inserted into the given handler.
      Specified by:
      canInsert in interface IFluidHelpersNeoForge
      Parameters:
      fluidHandler - A fluid handler.
      fluidStack - A fluid stack.
      Returns:
      If insertion is possible.

    • move

      public net.neoforged.neoforge.fluids.FluidStack move(net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> source, net.neoforged.neoforge.transfer.ResourceHandler<net.neoforged.neoforge.transfer.fluid.FluidResource> destination, int maxAmount, @Nullable @Nullable net.minecraft.world.entity.player.Player player, boolean emptySound, boolean simulate)
      Description copied from interface: IFluidHelpersNeoForge
      Move fluids from the given source and destination. If player is not null, a sound will be played.
      Specified by:
      move in interface IFluidHelpersNeoForge
      Parameters:
      source - A source handler.
      destination - A destination handler.
      maxAmount - The maximum amount to move.
      player - A player to play a sound for.
      emptySound - If the empty sound should be played, or otherwise the fill sound.
      simulate - If the movement must be simulated.
      Returns:
      The moved fluid.