net.minecraftforge.fluids.capability

Class FluidTankProperties

java.lang.Object

net.minecraftforge.fluids.capability.FluidTankProperties

All Implemented Interfaces:

IFluidTankProperties

public class FluidTankProperties
extends java.lang.Object
implements IFluidTankProperties

Basic implementation of IFluidTankProperties.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	canDrain
private boolean	canFill
private int	capacity
private FluidStack	contents

Constructor Summary

Constructors

Constructor and Description
FluidTankProperties(FluidStack contents, int capacity)
FluidTankProperties(FluidStack contents, int capacity, boolean canFill, boolean canDrain)

Method Summary

Modifier and Type	Method and Description
boolean	canDrain() Returns true if the tank can be drained at any time (even if it is currently empty).
boolean	canDrainFluidType(FluidStack fluidStack) Returns true if the tank can drain out this a specific of fluid.
boolean	canFill() Returns true if the tank can be filled at any time (even if it is currently full).
boolean	canFillFluidType(FluidStack fluidStack) Returns true if the tank can be filled with a specific type of fluid.
static FluidTankProperties[]	convert(FluidTankInfo[] fluidTankInfos)
int	getCapacity()
FluidStack	getContents()

Methods inherited from class java.lang.Object

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

Field Detail

contents

@Nullable
private final FluidStack contents

capacity

private final int capacity

canFill

private final boolean canFill

canDrain

private final boolean canDrain

Constructor Detail

FluidTankProperties

public FluidTankProperties(@Nullable
                           FluidStack contents,
                           int capacity)

FluidTankProperties

public FluidTankProperties(@Nullable
                           FluidStack contents,
                           int capacity,
                           boolean canFill,
                           boolean canDrain)

Method Detail

convert

public static FluidTankProperties[] convert(FluidTankInfo[] fluidTankInfos)

getContents

@Nullable
public FluidStack getContents()

Specified by:

getContents in interface IFluidTankProperties

Returns:

A copy of the fluid contents of this tank. May be null. To modify the contents, use IFluidHandler.

getCapacity

public int getCapacity()

Specified by:

getCapacity in interface IFluidTankProperties

Returns:

The maximum amount of fluid this tank can hold, in millibuckets.

canFill

public boolean canFill()

Description copied from interface: IFluidTankProperties

Returns true if the tank can be filled at any time (even if it is currently full). It does not consider the contents or capacity of the tank. This value is constant. If the tank behavior is more complicated, returns true.

Specified by:

canFill in interface IFluidTankProperties

canDrain

public boolean canDrain()

Description copied from interface: IFluidTankProperties

Returns true if the tank can be drained at any time (even if it is currently empty). It does not consider the contents or capacity of the tank. This value is constant. If the tank behavior is more complicated, returns true.

Specified by:

canDrain in interface IFluidTankProperties

canFillFluidType

public boolean canFillFluidType(FluidStack fluidStack)

Description copied from interface: IFluidTankProperties

Returns true if the tank can be filled with a specific type of fluid. Used as a filter for fluid types. Does not consider the current contents or capacity of the tank, only whether it could ever fill with this type of fluid. FluidStack is used here because fluid properties can depend on NBT, the amount is ignored.

Specified by:

canFillFluidType in interface IFluidTankProperties

canDrainFluidType

public boolean canDrainFluidType(FluidStack fluidStack)

Description copied from interface: IFluidTankProperties

Returns true if the tank can drain out this a specific of fluid. Used as a filter for fluid types. Does not consider the current contents or capacity of the tank, only whether it could ever drain out this type of fluid. FluidStack is used here because fluid properties can depend on NBT, the amount is ignored.

Specified by:

canDrainFluidType in interface IFluidTankProperties