net.minecraftforge.fluids.capability.wrappers

Class FluidBucketWrapper

java.lang.Object

net.minecraftforge.fluids.capability.wrappers.FluidBucketWrapper

All Implemented Interfaces:

ICapabilityProvider, IFluidHandler, IFluidHandlerItem

public class FluidBucketWrapper
extends java.lang.Object
implements IFluidHandlerItem, ICapabilityProvider

Wrapper for vanilla and forge buckets. Swaps between empty bucket and filled bucket of the correct type.

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemStack	container

Constructor Summary

Constructors

Constructor and Description
FluidBucketWrapper(ItemStack container)

Method Summary

Modifier and Type	Method and Description
boolean	canFillFluidType(FluidStack fluid)
FluidStack	drain(FluidStack resource, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
FluidStack	drain(int maxDrain, boolean doDrain) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
int	fill(FluidStack resource, boolean doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
<T> T	getCapability(Capability<T> capability, EnumFacing facing) Retrieves the handler for the capability requested on the specific side.
ItemStack	getContainer() Get the container currently acted on by this fluid handler.
FluidStack	getFluid()
IFluidTankProperties[]	getTankProperties() Returns an array of objects which represent the internal tanks.
boolean	hasCapability(Capability<?> capability, EnumFacing facing) Determines if this object has support for the capability in question on the specific side.
protected void	setFluid(Fluid fluid)

Methods inherited from class java.lang.Object

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

Field Detail

container

@Nonnull
protected ItemStack container

Constructor Detail

FluidBucketWrapper

public FluidBucketWrapper(@Nonnull
                          ItemStack container)

Method Detail

getContainer

@Nonnull
public ItemStack getContainer()

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)

getFluid

@Nullable
public FluidStack getFluid()

setFluid

protected void setFluid(@Nullable
                        Fluid fluid)

getTankProperties

public IFluidTankProperties[] getTankProperties()

Description copied from interface: IFluidHandler

Returns an array of objects which represent the internal tanks. These objects cannot be used to manipulate the internal tanks.

Specified by:

getTankProperties in interface IFluidHandler

Returns:

Properties for the relevant internal tanks.

fill

public int fill(FluidStack resource,
                boolean doFill)

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.

doFill - If false, fill will only be simulated.

Returns:

Amount of resource that was (or would have been, if simulated) filled.

drain

@Nullable
public FluidStack drain(FluidStack resource,
                                   boolean doDrain)

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.

doDrain - If false, drain will only be simulated.

Returns:

FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.

drain

@Nullable
public FluidStack drain(int maxDrain,
                                   boolean doDrain)

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.

doDrain - If false, drain will only be simulated.

Returns:

FluidStack representing the Fluid and amount that was (or would have been, if simulated) drained.

hasCapability

public boolean hasCapability(@Nonnull
                             Capability<?> capability,
                             @Nullable
                             EnumFacing facing)

Description copied from interface: ICapabilityProvider

Determines if this object has support for the capability in question on the specific side. The return value of this MIGHT change during runtime if this object gains or looses support for a capability. Example: A Pipe getting a cover placed on one side causing it loose the Inventory attachment function for that side. This is a light weight version of getCapability, intended for metadata uses.

Specified by:

hasCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

True if this object supports the capability.

getCapability

@Nullable
public <T> T getCapability(@Nonnull
                                      Capability<T> capability,
                                      @Nullable
                                      EnumFacing facing)

Description copied from interface: ICapabilityProvider

Retrieves the handler for the capability requested on the specific side. The return value CAN be null if the object does not support the capability. The return value CAN be the same for multiple faces.

Specified by:

getCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

The requested capability. Returns null when ICapabilityProvider.hasCapability(Capability, EnumFacing) would return false.