net.minecraftforge.fluids.capability.templates

クラス FluidHandlerItemStack

java.lang.Object

net.minecraftforge.fluids.capability.templates.FluidHandlerItemStack

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

ICapabilityProvider, IFluidHandler, IFluidHandlerItem

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

FluidHandlerItemStack.Consumable, FluidHandlerItemStack.SwapEmpty

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

FluidHandlerItemStack is a template capability provider for ItemStacks. Data is stored directly in the vanilla NBT, in the same way as the old ItemFluidContainer. This class allows an ItemStack to contain any partial level of fluid up to its capacity, unlike FluidHandlerItemStackSimple Additional examples are provided to enable consumable fluid containers (see FluidHandlerItemStack.Consumable), fluid containers with different empty and full items (see FluidHandlerItemStack.SwapEmpty,

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	FluidHandlerItemStack.Consumable Destroys the container item when it's emptied.
static class	FluidHandlerItemStack.SwapEmpty Swaps the container item for a different one when it's emptied.

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

IFluidHandler.FluidAction

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	capacity
protected ItemStack	container
static java.lang.String	FLUID_NBT_KEY

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

コンストラクタ

コンストラクタと説明
FluidHandlerItemStack(ItemStack container, int capacity)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	canDrainFluidType(FluidStack fluid)
boolean	canFillFluidType(FluidStack fluid)
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 doFill) Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
<T> LazyOptional<T>	getCapability(Capability<T> capability, Direction facing) Retrieves the Optional handler for the capability requested on the specific side.
ItemStack	getContainer() Get the container currently acted on by this fluid handler.
FluidStack	getFluid()
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.
protected void	setContainerToEmpty() Override this method for special handling.
protected void	setFluid(FluidStack fluid)

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

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

インタフェースから継承されたメソッド net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability

フィールドの詳細

FLUID_NBT_KEY

public static final java.lang.String FLUID_NBT_KEY

関連項目:

定数フィールド値

container

@Nonnull
protected ItemStack container

capacity

protected int capacity

コンストラクタの詳細

FluidHandlerItemStack

public FluidHandlerItemStack(@Nonnull
                             ItemStack container,
                             int capacity)

パラメータ:

container - The container itemStack, data is stored on it directly as NBT.

capacity - The maximum capacity of this fluid tank.

メソッドの詳細

getContainer

@Nonnull
public ItemStack getContainer()

インタフェースからコピーされた説明: 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.

定義:

getContainer インタフェース内 IFluidHandlerItem

getFluid

@Nonnull
public FluidStack getFluid()

setFluid

protected void setFluid(FluidStack fluid)

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 doFill)

インタフェースからコピーされた説明: 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.

doFill - 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.

canFillFluidType

public boolean canFillFluidType(FluidStack fluid)

canDrainFluidType

public boolean canDrainFluidType(FluidStack fluid)

setContainerToEmpty

protected void setContainerToEmpty()

Override this method for special handling. Can be used to swap out or destroy the container.

getCapability

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

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

Retrieves the Optional handler for the capability requested on the specific side. The return value CAN be the same for multiple faces. Modders are encouraged to cache this value, using the listener capabilities of the Optional to be notified if the requested capability get lost.

定義:

getCapability インタフェース内 ICapabilityProvider

戻り値:

The requested an optional holding the requested capability.