net.minecraftforge.fluids.capability.templates

クラス FluidTank

java.lang.Object

net.minecraftforge.fluids.capability.templates.FluidTank

すべての実装されたインタフェース:

IFluidHandler, IFluidTank

public class FluidTank
extends java.lang.Object
implements IFluidHandler, IFluidTank

Flexible implementation of a Fluid Storage object. NOT REQUIRED.

作成者:

King Lemming

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース net.minecraftforge.fluids.capability.IFluidHandler

IFluidHandler.FluidAction

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	capacity
protected FluidStack	fluid
protected java.util.function.Predicate<FluidStack>	validator

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FluidTank(int capacity)
FluidTank(int capacity, java.util.function.Predicate<FluidStack> validator)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FluidStack	drain(FluidStack resource, IFluidHandler.FluidAction action) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
FluidStack	drain(int maxDrain, IFluidHandler.FluidAction action) Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
int	fill(FluidStack resource, IFluidHandler.FluidAction action) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
int	getCapacity()
FluidStack	getFluid()
int	getFluidAmount()
FluidStack	getFluidInTank(int tank) Returns the FluidStack in a given tank.
int	getSpace()
int	getTankCapacity(int tank) Retrieves the maximum fluid amount for a given tank.
int	getTanks() Returns the number of fluid storage units ("tanks") available
boolean	isEmpty()
boolean	isFluidValid(FluidStack stack)
boolean	isFluidValid(int tank, FluidStack stack) This function is a way to determine which fluids can exist inside a given handler.
protected void	onContentsChanged()
FluidTank	readFromNBT(CompoundNBT nbt)
FluidTank	setCapacity(int capacity)
void	setFluid(FluidStack stack)
FluidTank	setValidator(java.util.function.Predicate<FluidStack> validator)
CompoundNBT	writeToNBT(CompoundNBT nbt)

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

validator

protected java.util.function.Predicate<FluidStack> validator

fluid

@Nonnull
protected FluidStack fluid

capacity

protected int capacity

コンストラクタの詳細

FluidTank

public FluidTank(int capacity)

FluidTank

public FluidTank(int capacity,
                 java.util.function.Predicate<FluidStack> validator)

メソッドの詳細

setCapacity

public FluidTank setCapacity(int capacity)

setValidator

public FluidTank setValidator(java.util.function.Predicate<FluidStack> validator)

isFluidValid

public boolean isFluidValid(FluidStack stack)

定義:

isFluidValid インタフェース内 IFluidTank

パラメータ:

stack - Fluidstack holding the Fluid to be queried.

戻り値:

If the tank can hold the fluid (EVER, not at the time of query).

getCapacity

public int getCapacity()

定義:

getCapacity インタフェース内 IFluidTank

戻り値:

Capacity of this fluid tank.

getFluid

@Nonnull
public FluidStack getFluid()

定義:

getFluid インタフェース内 IFluidTank

戻り値:

FluidStack representing the fluid in the tank, null if the tank is empty.

getFluidAmount

public int getFluidAmount()

定義:

getFluidAmount インタフェース内 IFluidTank

戻り値:

Current amount of fluid in the tank.

readFromNBT

public FluidTank readFromNBT(CompoundNBT nbt)

writeToNBT

public CompoundNBT writeToNBT(CompoundNBT nbt)

getTanks

public int getTanks()

インタフェースからコピーされた説明: IFluidHandler

Returns the number of fluid storage units ("tanks") available

定義:

getTanks インタフェース内 IFluidHandler

戻り値:

The number of tanks available

getFluidInTank

@Nonnull
public FluidStack getFluidInTank(int tank)

インタフェースからコピーされた説明: IFluidHandler

Returns the FluidStack in a given tank.

IMPORTANT: This FluidStack MUST NOT be modified. This method is not for altering internal contents. Any implementers who are able to detect modification via this method should throw an exception. It is ENTIRELY reasonable and likely that the stack returned here will be a copy.

SERIOUSLY: DO NOT MODIFY THE RETURNED FLUIDSTACK

定義:

getFluidInTank インタフェース内 IFluidHandler

パラメータ:

tank - Tank to query.

戻り値:

FluidStack in a given tank. FluidStack.EMPTY if the tank is empty.

getTankCapacity

public int getTankCapacity(int tank)

インタフェースからコピーされた説明: IFluidHandler

Retrieves the maximum fluid amount for a given tank.

定義:

getTankCapacity インタフェース内 IFluidHandler

パラメータ:

tank - Tank to query.

戻り値:

The maximum fluid amount held by the tank.

isFluidValid

public boolean isFluidValid(int tank,
                            @Nonnull
                            FluidStack stack)

インタフェースからコピーされた説明: IFluidHandler

This function is a way to determine which fluids can exist inside a given handler. General purpose tanks will basically always return TRUE for this.

定義:

isFluidValid インタフェース内 IFluidHandler

パラメータ:

tank - Tank to query for validity

stack - Stack to test with for validity

戻り値:

TRUE if the tank can hold the FluidStack, not considering current state. (Basically, is a given fluid EVER allowed in this tank?) Return FALSE if the answer to that question is 'no.'

fill

public int fill(FluidStack resource,
                IFluidHandler.FluidAction action)

インタフェースからコピーされた説明: IFluidHandler

Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.

定義:

fill インタフェース内 IFluidHandler

定義:

fill インタフェース内 IFluidTank

パラメータ:

resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.

action - If SIMULATE, fill will only be simulated.

戻り値:

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

drain

@Nonnull
public FluidStack drain(FluidStack resource,
                                  IFluidHandler.FluidAction action)

インタフェースからコピーされた説明: IFluidHandler

Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.

定義:

drain インタフェース内 IFluidHandler

定義:

drain インタフェース内 IFluidTank

パラメータ:

resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.

action - If SIMULATE, drain will only be simulated.

戻り値:

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

drain

@Nonnull
public FluidStack drain(int maxDrain,
                                  IFluidHandler.FluidAction action)

インタフェースからコピーされた説明: IFluidHandler

Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.

This method is not Fluid-sensitive.

定義:

drain インタフェース内 IFluidHandler

定義:

drain インタフェース内 IFluidTank

パラメータ:

maxDrain - Maximum amount of fluid to drain.

action - If SIMULATE, drain will only be simulated.

戻り値:

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

onContentsChanged

protected void onContentsChanged()

setFluid

public void setFluid(FluidStack stack)

isEmpty

public boolean isEmpty()

getSpace

public int getSpace()