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 boolean	interactWithTank(ItemStack stack, EntityPlayer player, IFluidHandler tank, EnumFacing side) Returns true if interaction was successful.
static ItemStack	tryEmptyBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side) Deprecated.
static ItemStack	tryEmptyBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side, EntityPlayer player) Takes a filled bucket and tries to empty it into the given tank.
static boolean	tryEmptyFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, EntityPlayer player)
static boolean	tryEmptyFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, IItemHandler inventory, int max, EntityPlayer player) Takes an IFluidContainerItem and tries to empty it into the given tank.
static ItemStack	tryFillBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side) Deprecated.
static ItemStack	tryFillBucket(ItemStack bucket, IFluidHandler tank, EnumFacing side, EntityPlayer player) Fill an empty bucket from the given tank.
static boolean	tryFillFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, EntityPlayer player) Takes an IFluidContainerItem and tries to fill it from the given tank.
static boolean	tryFillFluidContainerItem(ItemStack container, IFluidHandler tank, EnumFacing side, IItemHandler inventory, int max, EntityPlayer player) Takes an IFluidContainerItem and tries to fill it from the given tank.

Methods inherited from class java.lang.Object

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

Method Detail

interactWithTank

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

Returns true if interaction was successful.

tryFillBucket

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

Deprecated.

tryFillBucket

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

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

Parameters:

bucket - The empty bucket

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.

tryEmptyBucket

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

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 -

Returns:

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

tryFillFluidContainerItem

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

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

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

tryFillFluidContainerItem

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

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

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

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.