Package net.neoforged.neoforge.transfer.item

Class LivingEntityEquipmentWrapper

java.lang.Object

net.neoforged.neoforge.transfer.item.LivingEntityEquipmentWrapper

public class LivingEntityEquipmentWrapper
extends Object

Exposes the armor or hands inventory of an LivingEntity as a ResourceHandler<ItemResource> using LivingEntity.getItemBySlot(EquipmentSlot) and LivingEntity.setItemSlot(EquipmentSlot, ItemStack).

See Also:

• PlayerInventoryWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	LivingEntityEquipmentWrapper.EquipmentTypeWrapper
private class	LivingEntityEquipmentWrapper.SlotWrapper	The wrapper for a single EquipmentSlot, used as a building block.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<EquipmentSlot.Type,LivingEntityEquipmentWrapper.EquipmentTypeWrapper>	byType
private final LivingEntity	entity
private static final Map<LivingEntity,LivingEntityEquipmentWrapper>	wrappers	See VanillaContainerWrapper.wrappers which is similar.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LivingEntityEquipmentWrapper(LivingEntity entity)

Method Summary

Modifier and Type	Method	Description
private static LivingEntityEquipmentWrapper.EquipmentTypeWrapper	internalOf(LivingEntity entity, EquipmentSlot.Type equipmentType)
static ResourceHandler<ItemResource>	of(LivingEntity entity, EquipmentSlot equipmentSlot)	Gets a wrapper for a single equipment slot.
static ResourceHandler<ItemResource>	of(LivingEntity entity, EquipmentSlot.Type equipmentType)	Gets a wrapper for all equipment slots of a given type.

Methods inherited from class java.lang.Object

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

Field Details

wrappers

private static final Map<LivingEntity,LivingEntityEquipmentWrapper> wrappers

See VanillaContainerWrapper.wrappers which is similar.

We use weak keys and values to avoid keeping a strong reference to the LivingEntity until the next time the map is cleaned. As long as a slot wrapper is used, there is a strong reference to the outer LivingEntityEquipmentWrapper class, which also references the living entity. This ensures that the entries remain in the map at least as long as the wrappers are in use.

entity

private final LivingEntity entity

byType

private final Map<EquipmentSlot.Type,LivingEntityEquipmentWrapper.EquipmentTypeWrapper> byType

Constructor Details

LivingEntityEquipmentWrapper

private LivingEntityEquipmentWrapper(LivingEntity entity)

Method Details

of

public static ResourceHandler<ItemResource> of(LivingEntity entity,
 EquipmentSlot.Type equipmentType)

Gets a wrapper for all equipment slots of a given type.

Parameters:

entity - the entity whose equipment slots should be wrapped

equipmentType - the type of equipment slots to wrap

Throws:

IllegalArgumentException - if the entity is a player and the equipment type is neither EquipmentSlot.Type.HAND nor EquipmentSlot.Type.HUMANOID_ARMOR

of

public static ResourceHandler<ItemResource> of(LivingEntity entity,
 EquipmentSlot equipmentSlot)

Gets a wrapper for a single equipment slot.

Parameters:

entity - the entity whose equipment slots should be wrapped

equipmentSlot - the equipment slot to wrap

Throws:

IllegalArgumentException - if the entity is a player and the equipment slot's type is neither EquipmentSlot.Type.HAND nor EquipmentSlot.Type.HUMANOID_ARMOR

internalOf

private static LivingEntityEquipmentWrapper.EquipmentTypeWrapper internalOf(LivingEntity entity,
 EquipmentSlot.Type equipmentType)