net.minecraftforge.fluids.capability.templates

クラス VoidFluidHandler

java.lang.Object

net.minecraftforge.fluids.capability.templates.VoidFluidHandler

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

IFluidHandler

直系の既知のサブクラス:

BlockWrapper

public class VoidFluidHandler
extends java.lang.Object
implements IFluidHandler

VoidFluidHandler is a template fluid handler that can be filled indefinitely without ever getting full. It does not store fluid that gets filled into it, but "destroys" it upon receiving it.

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

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

IFluidHandler.FluidAction

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static VoidFluidHandler	INSTANCE

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

コンストラクタ

コンストラクタと説明
VoidFluidHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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.
FluidStack	getFluidInTank(int tank) Returns the FluidStack in a given tank.
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	isFluidValid(int tank, FluidStack stack) This function is a way to determine which fluids can exist inside a given handler.

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

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

フィールドの詳細

INSTANCE

public static final VoidFluidHandler INSTANCE

コンストラクタの詳細

VoidFluidHandler

public VoidFluidHandler()

メソッドの詳細

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

パラメータ:

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

パラメータ:

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

パラメータ:

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.