net.minecraftforge.fluids

Class FluidUtil

java.lang.Object

net.minecraftforge.fluids.FluidUtil

public class FluidUtil
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static FluidStack	getFluidContained(ItemStack container) Helper method to get the fluid contained in an itemStack
static IFluidHandler	getFluidHandler(ItemStack itemStack) Helper method to get an IFluidHandler for an itemStack.
static IFluidHandler	getFluidHandler(World world, BlockPos blockPos, EnumFacing side) Helper method to get an IFluidHandler for at a block position.
static boolean	interactWithFluidHandler(ItemStack stack, IFluidHandler fluidHandler, EntityPlayer player) Used to handle the common case of a fluid item right-clicking on a fluid handler.
static boolean	interactWithTank(ItemStack stack, EntityPlayer player, IFluidHandler tank, EnumFacing side) Deprecated. use interactWithFluidHandler(ItemStack, IFluidHandler, EntityPlayer)
static ItemStack	tryEmptyBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side) Deprecated. use tryEmptyContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)
static ItemStack	tryEmptyBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side, EntityPlayer player) Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)
static ItemStack	tryEmptyContainer(ItemStack container, IFluidHandler fluidDestination, int maxAmount, EntityPlayer player, boolean doDrain) Takes a filled container and tries to empty it into the given tank.
static boolean	tryEmptyContainerAndStow(ItemStack container, IFluidHandler fluidDestination, IItemHandler inventory, int maxAmount, EntityPlayer player) Takes an Fluid Container Item, tries to empty it into the fluid handler, and stows it in the given inventory.
static boolean	tryEmptyFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, EntityPlayer player) Deprecated. use tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)
static boolean	tryEmptyFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, IItemHandler inventory, int max, EntityPlayer player) Deprecated. use tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)
static ItemStack	tryFillBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side) Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)
static ItemStack	tryFillBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side, EntityPlayer player) Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)
static ItemStack	tryFillContainer(ItemStack container, IFluidHandler fluidSource, int maxAmount, EntityPlayer player, boolean doFill) Fill a container from the given fluidSource.
static boolean	tryFillContainerAndStow(ItemStack container, IFluidHandler fluidSource, IItemHandler inventory, int maxAmount, EntityPlayer player) Takes an Fluid Container Item and tries to fill it from the given tank.
static boolean	tryFillFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, EntityPlayer player) Deprecated. use tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)
static boolean	tryFillFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, IItemHandler inventory, int max, EntityPlayer player) Deprecated. use tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)
static FluidStack	tryFluidTransfer(IFluidHandler fluidDestination, IFluidHandler fluidSource, int maxAmount, boolean doTransfer) Fill a destination fluid handler from a source fluid handler.
static ItemStack	tryPickUpFluid(ItemStack emptyContainer, EntityPlayer playerIn, World worldIn, BlockPos pos, EnumFacing side) Attempts to pick up a fluid in the world and put it in an empty container item.
static boolean	tryPlaceFluid(EntityPlayer player, World worldIn, FluidStack fluidStack, BlockPos pos) Tries to place a fluid in the world in block form.

Methods inherited from class java.lang.Object

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

Method Detail

interactWithFluidHandler

public static boolean interactWithFluidHandler(ItemStack stack,
                                               IFluidHandler fluidHandler,
                                               EntityPlayer player)

Used to handle the common case of a fluid item right-clicking on a fluid handler. First it tries to fill the container item from the fluid handler, if that action fails then it tries to drain the container item into the fluid handler. Returns true if interaction was successful. Returns false if interaction failed.

tryFillContainer

public static ItemStack tryFillContainer(ItemStack container,
                                         IFluidHandler fluidSource,
                                         int maxAmount,
                                         @Nullable
                                         EntityPlayer player,
                                         boolean doFill)

Fill a container from the given fluidSource.

Parameters:

container - The container to be filled. Will not be modified.

fluidSource - The fluid handler to be drained.

maxAmount - The largest amount of fluid that should be transferred.

player - The player to make the filling noise. Pass null for no noise.

doFill - true if the container should actually be filled, false if it should be simulated.

Returns:

The filled container or null if the liquid couldn't be taken from the tank.

tryEmptyContainer

@Nullable
public static ItemStack tryEmptyContainer(ItemStack container,
                                                     IFluidHandler fluidDestination,
                                                     int maxAmount,
                                                     @Nullable
                                                     EntityPlayer player,
                                                     boolean doDrain)

Takes a filled container and tries to empty it into the given tank.

Parameters:

container - The filled container. Will not be modified.

fluidDestination - The fluid handler to be filled by the container.

maxAmount - The largest amount of fluid that should be transferred.

player - Player for making the bucket drained sound. Pass null for no noise.

doDrain - true if the container should actually be drained, false if it should be simulated.

Returns:

The empty container if successful, null if the fluid handler couldn't be filled. NOTE The empty container will have a stackSize of 0 when a filled container is consumable, i.e. it has a "null" empty container but has successfully been emptied.

tryFillContainerAndStow

public static boolean tryFillContainerAndStow(ItemStack container,
                                              IFluidHandler fluidSource,
                                              IItemHandler inventory,
                                              int maxAmount,
                                              @Nullable
                                              EntityPlayer player)

Takes an Fluid Container Item and tries to fill it from the given tank. If the player is in creative mode, the container will not be modified on success, and no additional items created. If the input itemstack has a stacksize > 1 it will stow the filled container in the given inventory. If the inventory does not accept it, it will be given to the player or dropped at the players feet. If player is null in this case, the action will be aborted.

Parameters:

container - The Fluid Container Itemstack to fill. This stack WILL be modified on success.

fluidSource - The fluid source to fill from

inventory - An inventory where any additionally created item (filled container if multiple empty are present) are put

maxAmount - Maximum amount of fluid to take from the tank.

player - The player that gets the items the inventory can't take. Can be null, only used if the inventory cannot take the filled stack.

Returns:

True if the container was filled successfully and stowed, false otherwise.

tryEmptyContainerAndStow

public static boolean tryEmptyContainerAndStow(ItemStack container,
                                               IFluidHandler fluidDestination,
                                               IItemHandler inventory,
                                               int maxAmount,
                                               @Nullable
                                               EntityPlayer player)

Takes an Fluid Container Item, tries to empty it into the fluid handler, and stows it in the given inventory. If the player is in creative mode, the container will not be modified on success, and no additional items created. If the input itemstack has a stacksize > 1 it will stow the emptied container in the given inventory. If the inventory does not accept the emptied container, it will be given to the player or dropped at the players feet. If player is null in this case, the action will be aborted.

Parameters:

container - The filled Fluid Container Itemstack to empty. This stack WILL be modified on success.

fluidDestination - The fluid destination to fill from the fluid container.

inventory - An inventory where any additionally created item (filled container if multiple empty are present) are put

maxAmount - Maximum amount of fluid to take from the tank.

player - The player that gets the items the inventory can't take. Can be null, only used if the inventory cannot take the filled stack.

Returns:

True if the container was filled successfully and stowed, false otherwise.

tryFluidTransfer

@Nullable
public static FluidStack tryFluidTransfer(IFluidHandler fluidDestination,
                                                     IFluidHandler fluidSource,
                                                     int maxAmount,
                                                     boolean doTransfer)

Fill a destination fluid handler from a source fluid handler.

Parameters:

fluidDestination - The fluid handler to be filled.

fluidSource - The fluid handler to be drained.

maxAmount - The largest amount of fluid that should be transferred.

doTransfer - True if the transfer should actually be done, false if it should be simulated.

Returns:

the fluidStack that was transferred from the source to the destination. null on failure.

getFluidHandler

@Nullable
public static IFluidHandler getFluidHandler(ItemStack itemStack)

Helper method to get an IFluidHandler for an itemStack. The itemStack passed in here WILL be modified, the IFluidHandler acts on it directly. Note that the itemStack MUST have a stackSize of 1 if you want to fill or drain it. You can't fill or drain a whole stack at once, if you do then liquid is multiplied or destroyed. Vanilla buckets will be converted to universal buckets if they are enabled. Returns null if the itemStack passed in does not have a fluid handler.

getFluidContained

@Nullable
public static FluidStack getFluidContained(ItemStack container)

Helper method to get the fluid contained in an itemStack

getFluidHandler

@Nullable
public static IFluidHandler getFluidHandler(World world,
                                                       BlockPos blockPos,
                                                       @Nullable
                                                       EnumFacing side)

Helper method to get an IFluidHandler for at a block position. Returns null if there is no valid fluid handler.

tryPlaceFluid

public static boolean tryPlaceFluid(@Nullable
                                    EntityPlayer player,
                                    World worldIn,
                                    FluidStack fluidStack,
                                    BlockPos pos)

Tries to place a fluid in the world in block form. Makes a fluid emptying sound when successful. Checks if water-like fluids should vaporize like in the nether. Modeled after ItemBucket.tryPlaceContainedLiquid(EntityPlayer, World, BlockPos)

Parameters:

player - Player who places the fluid. May be null for blocks like dispensers.

worldIn - World to place the fluid in

fluidStack - The fluidStack to place.

pos - The position in the world to place the fluid block

Returns:

true if successful

tryPickUpFluid

@Nullable
public static ItemStack tryPickUpFluid(ItemStack emptyContainer,
                                                  @Nullable
                                                  EntityPlayer playerIn,
                                                  World worldIn,
                                                  BlockPos pos,
                                                  EnumFacing side)

Attempts to pick up a fluid in the world and put it in an empty container item.

Parameters:

emptyContainer - The empty container to fill. Will not be modified.

playerIn - The player filling the container. Optional.

worldIn - The world the fluid is in.

pos - The position of the fluid in the world.

side - The side of the fluid that is being drained.

Returns:

a filled container if it was successful. returns null on failure.

interactWithTank

@Deprecated
public static boolean interactWithTank(ItemStack stack,
                                                    EntityPlayer player,
                                                    IFluidHandler tank,
                                                    EnumFacing side)

Deprecated. use interactWithFluidHandler(ItemStack, IFluidHandler, EntityPlayer)

Returns true if interaction was successful.

tryFillBucket

@Deprecated
public static ItemStack tryFillBucket(ItemStack bucket,
                                                   IFluidHandler tank,
                                                   EnumFacing side)

Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)

tryFillBucket

@Deprecated
public static ItemStack tryFillBucket(ItemStack bucket,
                                                   IFluidHandler tank,
                                                   EnumFacing side,
                                                   EntityPlayer player)

Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)

Fill an empty bucket from the given tank. Uses the FluidContainerRegistry.

Parameters:

bucket - The empty bucket. Will not be modified.

tank - The tank to fill the bucket from

side - Side to access the tank from

Returns:

The filled bucket or null if the liquid couldn't be taken from the tank.

tryEmptyBucket

@Deprecated
public static ItemStack tryEmptyBucket(ItemStack bucket,
                                                    IFluidHandler tank,
                                                    EnumFacing side)

Deprecated. use tryEmptyContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)

tryEmptyBucket

@Deprecated
public static ItemStack tryEmptyBucket(ItemStack bucket,
                                                    IFluidHandler tank,
                                                    EnumFacing side,
                                                    EntityPlayer player)

Deprecated. use tryFillContainer(ItemStack, IFluidHandler, int, EntityPlayer, boolean)

Takes a filled bucket and tries to empty it into the given tank. Uses the FluidContainerRegistry.

Parameters:

bucket - The filled bucket

tank - The tank to fill with the bucket

side - Side to access the tank from

player - Player for making the bucket drained sound.

Returns:

The empty bucket if successful, null if the tank couldn't be filled.

tryFillFluidContainerItem

@Deprecated
public static boolean tryFillFluidContainerItem(ItemStack container,
                                                             IFluidHandler tank,
                                                             EnumFacing side,
                                                             EntityPlayer player)

Deprecated. use tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)

Takes an IFluidContainerItem and tries to fill it from the given tank.

Parameters:

container - The IFluidContainerItem Itemstack to fill. WILL BE MODIFIED!

tank - The tank to fill from

side - Side to access the tank from

player - The player that tries to fill the bucket. Needed if the input itemstack has a stacksize > 1 to determine where the filled container goes.

Returns:

True if the IFluidContainerItem was filled successfully, false otherwise. The passed container will have been modified to accommodate for anything done in this method. New Itemstacks might have been added to the players inventory.

tryEmptyFluidContainerItem

@Deprecated
public static boolean tryEmptyFluidContainerItem(ItemStack container,
                                                              IFluidHandler tank,
                                                              EnumFacing side,
                                                              EntityPlayer player)

Deprecated. use tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)

tryFillFluidContainerItem

@Deprecated
public static boolean tryFillFluidContainerItem(ItemStack container,
                                                             IFluidHandler tank,
                                                             EnumFacing side,
                                                             IItemHandler inventory,
                                                             int max,
                                                             @Nullable
                                                             EntityPlayer player)

Deprecated. use tryFillContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)

Takes an IFluidContainerItem and tries to fill it from the given tank. If the input itemstack has a stacksize >1 new itemstacks will be created and inserted into the given inventory. If the inventory does not accept it, it will be given to the player or dropped at the players feet. If player is null in this case, the action will be aborted. To support buckets that are not in the FluidContainerRegistry but implement IFluidContainerItem be sure to convert the empty bucket to your empty bucket variant before passing it to this function.

Parameters:

container - The IFluidContainerItem Itemstack to fill. WILL BE MODIFIED!

tank - The tank to fill from

side - Side to access the tank from

inventory - An inventory where any additionally created item (filled container if multiple empty are present) are put

max - Maximum amount to take from the tank. Uses IFluidContainerItem capacity if <= 0

player - The player that gets the items the inventory can't take. Can be null, only used if the inventory cannot take the filled stack.

Returns:

True if the IFluidContainerItem was filled successfully, false otherwise. The passed container will have been modified to accommodate for anything done in this method. New Itemstacks might have been added to the players inventory.

tryEmptyFluidContainerItem

@Deprecated
public static boolean tryEmptyFluidContainerItem(ItemStack container,
                                                              IFluidHandler tank,
                                                              EnumFacing side,
                                                              IItemHandler inventory,
                                                              int max,
                                                              EntityPlayer player)

Deprecated. use tryEmptyContainerAndStow(ItemStack, IFluidHandler, IItemHandler, int, EntityPlayer)

Takes an IFluidContainerItem and tries to empty it into the given tank. If the input itemstack has a stacksize >1 new itemstacks will be created and inserted into the given inventory. If the inventory does not accept it, it will be given to the player or dropped at the players feet. If player is null in this case, the action will be aborted.

Parameters:

container - The IFluidContainerItem Itemstack to empty. WILL BE MODIFIED!

tank - The tank to fill

side - Side to access the tank from

inventory - An inventory where any additionally created item (filled container if multiple empty are present) are put

max - Maximum amount to take from the tank. Uses IFluidContainerItem capacity if <= 0

player - The player that gets the items the inventory can't take. Can be null, only used if the inventory cannot take the emptied stack.

Returns:

True if the container successfully emptied at least 1 mb into the tank, false otherwise. The passed container itemstack will be modified to accommodate for the liquid transaction.