Package net.neoforged.neoforge.transfer.item

Class PlayerInventoryWrapper.ArmorSlotWrapper

java.lang.Object

net.neoforged.neoforge.transfer.transaction.SnapshotJournal<ItemStack>

net.neoforged.neoforge.transfer.item.ItemStackResourceHandler

net.neoforged.neoforge.transfer.item.VanillaContainerWrapper.SlotWrapper

net.neoforged.neoforge.transfer.item.PlayerInventoryWrapper.ArmorSlotWrapper

All Implemented Interfaces:

ValueIOSerializable, ResourceHandler<ItemResource>

Enclosing class:

PlayerInventoryWrapper

private class PlayerInventoryWrapper.ArmorSlotWrapper
extends VanillaContainerWrapper.SlotWrapper

Specialized slot wrapper for one of the armor slots. Limits size to 1, disallows insertion of non-equippable items, and extraction of cursed items for non-creative players.

Field Summary

Fields

Modifier and Type	Field	Description
private final EquipmentSlot	slot

Fields inherited from class net.neoforged.neoforge.transfer.item.ItemStackResourceHandler

VALUE_IO_KEY

Constructor Summary

Constructors

Constructor	Description
ArmorSlotWrapper(int index, EquipmentSlot slot)

Method Summary

Modifier and Type	Method	Description
int	extract(int index, ItemResource resource, int amount, TransactionContext transaction)	Extracts up to the given amount of a resource from the handler at the given index.
protected int	getCapacity(ItemResource resource)	Special cases because vanilla checks the current stack in the following functions (which it shouldn't): AbstractFurnaceBlockEntity.canPlaceItem(int, ItemStack). BrewingStandBlockEntity.canPlaceItem(int, ItemStack).
protected boolean	isValid(ItemResource resource)	Return true if the passed non-empty item resource can fit in this handler, false otherwise.

Methods inherited from class net.neoforged.neoforge.transfer.item.VanillaContainerWrapper.SlotWrapper

getStack, insert, onRootCommit, setStack, toString, updateSnapshots

Methods inherited from class net.neoforged.neoforge.transfer.item.ItemStackResourceHandler

createSnapshot, deserialize, getAmountAsLong, getCapacityAsLong, getResource, isValid, revertToSnapshot, serialize, size

Methods inherited from class net.neoforged.neoforge.transfer.transaction.SnapshotJournal

releaseSnapshot

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.neoforge.transfer.ResourceHandler

extract, getAmountAsInt, getCapacityAsInt, insert

Field Details

slot

private final EquipmentSlot slot

Constructor Details

ArmorSlotWrapper

ArmorSlotWrapper(int index,
 EquipmentSlot slot)

Method Details

isValid

protected boolean isValid(ItemResource resource)

Description copied from class: ItemStackResourceHandler

Return true if the passed non-empty item resource can fit in this handler, false otherwise.

The result of this function is used in the provided implementations of:

• ItemStackResourceHandler.isValid(int, ItemResource), to report which items are valid;
• ItemStackResourceHandler.getCapacityAsLong(int, ItemResource), to report a capacity of 0 for invalid items;
• ItemStackResourceHandler.insert(int, ItemResource, int, TransactionContext), to reject items that cannot fit in this handler.

Overrides:

isValid in class VanillaContainerWrapper.SlotWrapper

getCapacity

protected int getCapacity(ItemResource resource)

Description copied from class: VanillaContainerWrapper.SlotWrapper

Special cases because vanilla checks the current stack in the following functions (which it shouldn't):

• AbstractFurnaceBlockEntity.canPlaceItem(int, ItemStack).
• BrewingStandBlockEntity.canPlaceItem(int, ItemStack).

Should these extra checks cause performance issues, we can switch to subclasses.

Overrides:

getCapacity in class VanillaContainerWrapper.SlotWrapper

Returns:

The maximum capacity of this handler for the passed item resource.

extract

public int extract(int index,
 ItemResource resource,
 int amount,
 TransactionContext transaction)

Description copied from interface: ResourceHandler

Extracts up to the given amount of a resource from the handler at the given index.

Changes to the handler are made in the context of a transaction.

Specified by:

extract in interface ResourceHandler<ItemResource>

Overrides:

extract in class VanillaContainerWrapper.SlotWrapper

Parameters:

index - The index to extract the resource from.

resource - The resource to extract. Must be non-empty.

amount - The maximum amount of the resource to extract. Must be non-negative.

transaction - The transaction that this operation is part of.

Returns:

The amount that was extracted. Between 0 (inclusive, nothing was extracted) and amount (inclusive, everything was extracted).

See Also:

• Extracting without a specific index, which can be more efficient.