Package net.neoforged.neoforge.transfer.item

Class PlayerInventoryWrapper

java.lang.Object

net.neoforged.neoforge.transfer.item.VanillaContainerWrapper

net.neoforged.neoforge.transfer.item.PlayerInventoryWrapper

All Implemented Interfaces:

ResourceHandler<ItemResource>

public final class PlayerInventoryWrapper
extends VanillaContainerWrapper

An implementation of ResourceHandler<ItemResource> for the Inventory of a Player.

See Also:

• VanillaContainerWrapper
• WorldlyContainerWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	PlayerInventoryWrapper.ArmorSlotWrapper	Specialized slot wrapper for one of the armor slots.
private class	PlayerInventoryWrapper.DroppedItems

Nested classes/interfaces inherited from class net.neoforged.neoforge.transfer.item.VanillaContainerWrapper

VanillaContainerWrapper.SlotWrapper

Field Summary

Fields

Modifier and Type	Field	Description
private final PlayerInventoryWrapper.DroppedItems	droppedItems
private final Inventory	inventory

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

size, slotWrappers

Constructor Summary

Constructors

Constructor	Description
PlayerInventoryWrapper(Inventory inventory)

Method Summary

Modifier and Type	Method	Description
void	drop(ItemResource resource, int amount, boolean dropAround, boolean includeThrowerName, TransactionContext transaction)	Transactionally drops an item in the world.
ResourceHandler<ItemResource>	getArmorSlot(EquipmentSlot slot)	Retrieves a wrapper around a single armor slot.
ResourceHandler<ItemResource>	getArmorSlots()	Retrieves a wrapper around all 4 armor slots.
ResourceHandler<ItemResource>	getHandSlot(InteractionHand hand)	Retrieves a wrapper for the slot corresponding to the given hand.
ResourceHandler<ItemResource>	getHandSlots()	Retrieves a wrapper around both hand slots.
ResourceHandler<ItemResource>	getMainHandSlot()	Retrieves a wrapper for the slot corresponding to the current main hand.
ResourceHandler<ItemResource>	getMainSlots()	Retrieves a wrapper around the main slots only.
ResourceHandler<ItemResource>	getSlot(int slot)	Retrieves a wrapper for a specific slot.
int	insert(ItemResource resource, int amount, TransactionContext transaction)	Inserts items into this player inventory, trying to place items following the logic of Inventory.placeItemBackInInventory(net.minecraft.world.item.ItemStack).
static PlayerInventoryWrapper	of(Inventory inventory)	Gets the inventory wrapper for a player's Inventory.
static PlayerInventoryWrapper	of(Player player)	Gets the inventory wrapper for a Player.
(package private) void	onRootCommit()
void	placeItemBackInInventory(ItemResource resource, int amount, TransactionContext transactionContext)	Transactional version of Inventory.placeItemBackInInventory(net.minecraft.world.item.ItemStack): tries to insert as much as possible into the player inventory, and drops the remainder.
(package private) void	resize()
String	toString()

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

extract, getAmountAsLong, getCapacityAsLong, getResource, getSlotWrapper, insert, internalOf, isValid, of, size

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

Field Details

droppedItems

private final PlayerInventoryWrapper.DroppedItems droppedItems

inventory

private final Inventory inventory

Constructor Details

PlayerInventoryWrapper

PlayerInventoryWrapper(Inventory inventory)

Method Details

of

public static PlayerInventoryWrapper of(Player player)

Gets the inventory wrapper for a Player.

of

public static PlayerInventoryWrapper of(Inventory inventory)

Gets the inventory wrapper for a player's Inventory.

resize

void resize()

Overrides:

resize in class VanillaContainerWrapper

onRootCommit

void onRootCommit()

Overrides:

onRootCommit in class VanillaContainerWrapper

getSlot

public ResourceHandler<ItemResource> getSlot(int slot)

Retrieves a wrapper for a specific slot.

getMainHandSlot

public ResourceHandler<ItemResource> getMainHandSlot()

Retrieves a wrapper for the slot corresponding to the current main hand.

getHandSlot

public ResourceHandler<ItemResource> getHandSlot(InteractionHand hand)

Retrieves a wrapper for the slot corresponding to the given hand.

getHandSlots

public ResourceHandler<ItemResource> getHandSlots()

Retrieves a wrapper around both hand slots.

getMainSlots

public ResourceHandler<ItemResource> getMainSlots()

Retrieves a wrapper around the main slots only.

getArmorSlot

public ResourceHandler<ItemResource> getArmorSlot(EquipmentSlot slot)

Retrieves a wrapper around a single armor slot.

getArmorSlots

public ResourceHandler<ItemResource> getArmorSlots()

Retrieves a wrapper around all 4 armor slots.

insert

public int insert(ItemResource resource,
 int amount,
 TransactionContext transaction)

Inserts items into this player inventory, trying to place items following the logic of Inventory.placeItemBackInInventory(net.minecraft.world.item.ItemStack).

Parameters:

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

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

transaction - The transaction that this operation is part of.

Returns:

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

See Also:

• Inserting into a specific index of the handler.

placeItemBackInInventory

public void placeItemBackInInventory(ItemResource resource,
 int amount,
 TransactionContext transactionContext)

Transactional version of Inventory.placeItemBackInInventory(net.minecraft.world.item.ItemStack): tries to insert as much as possible into the player inventory, and drops the remainder.

drop

public void drop(ItemResource resource,
 int amount,
 boolean dropAround,
 boolean includeThrowerName,
 TransactionContext transaction)

Transactionally drops an item in the world.

toString

public String toString()

Overrides:

toString in class VanillaContainerWrapper