net.minecraftforge.items.wrapper

クラス RangedWrapper

java.lang.Object

net.minecraftforge.items.wrapper.RangedWrapper

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

IItemHandler, IItemHandlerModifiable

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

PlayerArmorInvWrapper, PlayerMainInvWrapper, PlayerOffhandInvWrapper

public class RangedWrapper
extends java.lang.Object
implements IItemHandlerModifiable

A wrapper that composes another IItemHandlerModifiable, exposing only a range of the composed slots. Shifting of slot indices is handled automatically for you.

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

コンストラクタ

コンストラクタと説明
RangedWrapper(IItemHandlerModifiable compose, int minSlot, int maxSlotExclusive)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ItemStack	extractItem(int slot, int amount, boolean simulate) Extracts an ItemStack from the given slot.
int	getSlotLimit(int slot) Retrieves the maximum stack size allowed to exist in the given slot.
int	getSlots() Returns the number of slots available
ItemStack	getStackInSlot(int slot) Returns the ItemStack in a given slot.
ItemStack	insertItem(int slot, ItemStack stack, boolean simulate) Inserts an ItemStack into the given slot and return the remainder.
boolean	isItemValid(int slot, ItemStack stack) This function re-implements the vanilla function IInventory.isItemValidForSlot(int, ItemStack).
void	setStackInSlot(int slot, ItemStack stack) Overrides the stack in the given slot.

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

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

コンストラクタの詳細

RangedWrapper

public RangedWrapper(IItemHandlerModifiable compose,
                     int minSlot,
                     int maxSlotExclusive)

メソッドの詳細

getSlots

public int getSlots()

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

Returns the number of slots available

定義:

getSlots インタフェース内 IItemHandler

戻り値:

The number of slots available

getStackInSlot

@Nonnull
public ItemStack getStackInSlot(int slot)

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

Returns the ItemStack in a given slot. The result's stack size may be greater than the itemstack's max size. If the result is empty, then the slot is empty.

IMPORTANT: This ItemStack MUST NOT be modified. This method is not for altering an inventory's contents. Any implementers who are able to detect modification through this method should throw an exception.

SERIOUSLY: DO NOT MODIFY THE RETURNED ITEMSTACK

定義:

getStackInSlot インタフェース内 IItemHandler

パラメータ:

slot - Slot to query

戻り値:

ItemStack in given slot. Empty Itemstack if the slot is empty.

insertItem

@Nonnull
public ItemStack insertItem(int slot,
                                      @Nonnull
                                      ItemStack stack,
                                      boolean simulate)

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

Inserts an ItemStack into the given slot and return the remainder. The ItemStack should not be modified in this function!

Note: This behaviour is subtly different from IFluidHandler#fill(FluidStack, boolean)

定義:

insertItem インタフェース内 IItemHandler

パラメータ:

slot - Slot to insert into.

stack - ItemStack to insert. This must not be modified by the item handler.

simulate - If true, the insertion is only simulated

戻り値:

The remaining ItemStack that was not inserted (if the entire stack is accepted, then return an empty ItemStack). May be the same as the input ItemStack if unchanged, otherwise a new ItemStack. The returned ItemStack can be safely modified after.

extractItem

@Nonnull
public ItemStack extractItem(int slot,
                                       int amount,
                                       boolean simulate)

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

Extracts an ItemStack from the given slot.

The returned value must be empty if nothing is extracted, otherwise its stack size must be less than or equal to amount and ItemStack.getMaxStackSize().

定義:

extractItem インタフェース内 IItemHandler

パラメータ:

slot - Slot to extract from.

amount - Amount to extract (may be greater than the current stack's max limit)

simulate - If true, the extraction is only simulated

戻り値:

ItemStack extracted from the slot, must be empty if nothing can be extracted. The returned ItemStack can be safely modified after, so item handlers should return a new or copied stack.

setStackInSlot

public void setStackInSlot(int slot,
                           @Nonnull
                           ItemStack stack)

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

Overrides the stack in the given slot. This method is used by the standard Forge helper methods and classes. It is not intended for general use by other mods, and the handler may throw an error if it is called unexpectedly.

定義:

setStackInSlot インタフェース内 IItemHandlerModifiable

パラメータ:

slot - Slot to modify

stack - ItemStack to set slot to (may be empty).

getSlotLimit

public int getSlotLimit(int slot)

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

Retrieves the maximum stack size allowed to exist in the given slot.

定義:

getSlotLimit インタフェース内 IItemHandler

パラメータ:

slot - Slot to query.

戻り値:

The maximum stack size allowed in the slot.

isItemValid

public boolean isItemValid(int slot,
                           @Nonnull
                           ItemStack stack)

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

This function re-implements the vanilla function IInventory.isItemValidForSlot(int, ItemStack). It should be used instead of simulated insertions in cases where the contents and state of the inventory are irrelevant, mainly for the purpose of automation and logic (for instance, testing if a minecart can wait to deposit its items into a full inventory, or if the items in the minecart can never be placed into the inventory and should move on).

• isItemValid is false when insertion of the item is never valid.
• When isItemValid is true, no assumptions can be made and insertion must be simulated case-by-case.
• The actual items in the inventory, its fullness, or any other state are not considered by isItemValid.

定義:

isItemValid インタフェース内 IItemHandler

パラメータ:

slot - Slot to query for validity

stack - Stack to test with for validity

戻り値:

true if the slot can insert the ItemStack, not considering the current state of the inventory. false if the slot can never insert the ItemStack in any situation.