Package net.neoforged.neoforge.transfer.item

Class ItemAccessItemHandler

java.lang.Object

net.neoforged.neoforge.transfer.ItemAccessResourceHandler<ItemResource>

net.neoforged.neoforge.transfer.item.ItemAccessItemHandler

All Implemented Interfaces:

ResourceHandler<ItemResource>

public class ItemAccessItemHandler
extends ItemAccessResourceHandler<ItemResource>

Base implementation of an item ResourceHandler backed by an ItemAccess. The stacks are stored in a ItemContainerContents data component.

To use this class, register a new DataComponentType which holds an ItemContainerContents for your item. Then reference that component from your ICapabilityProvider passed to RegisterCapabilitiesEvent.registerItem(net.neoforged.neoforge.capabilities.ItemCapability<T, C>, net.neoforged.neoforge.capabilities.ICapabilityProvider<net.minecraft.world.item.ItemStack, C, T>, net.minecraft.world.level.ItemLike...) to create an instance of this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataComponentType<ItemContainerContents>	component
protected final Item	validItem

Fields inherited from class net.neoforged.neoforge.transfer.ItemAccessResourceHandler

itemAccess, size

Constructor Summary

Constructors

Constructor	Description
ItemAccessItemHandler(ItemAccess itemAccess, DataComponentType<ItemContainerContents> component, int size)

Method Summary

Modifier and Type	Method	Description
protected int	getAmountFrom(ItemResource accessResource, int index)	Retrieves the amount stored in the current contents of the item access.
protected int	getCapacity(int index, ItemResource resource)	Return the maximum capacity of this handler for the passed resource.
protected ItemContainerContents	getContents(ItemResource accessResource)	Retrieves the ItemContainerContents from the current resource of the item access.
protected ItemResource	getResourceFrom(ItemResource accessResource, int index)	Retrieves the resource stored in the current contents of the item access.
protected ItemStack	getStackFromContents(ItemContainerContents contents, int slot)	Retrieves a copy of a single stack from the underlying data component, returning ItemStack.EMPTY if the component does not have a slot present.
boolean	isValid(int index, ItemResource resource)	Return true if the passed non-empty resource can fit in this handler, false otherwise.
protected ItemResource	update(ItemResource accessResource, int index, ItemResource newResource, int newAmount)	Returns a resource with updated resource and amount.

Methods inherited from class net.neoforged.neoforge.transfer.ItemAccessResourceHandler

extract, getAmountAsLong, getCapacityAsLong, getResource, insert, size

Methods inherited from class java.lang.Object

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

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

extract, getAmountAsInt, getCapacityAsInt, insert

Field Details

validItem

protected final Item validItem

component

protected final DataComponentType<ItemContainerContents> component

Constructor Details

ItemAccessItemHandler

public ItemAccessItemHandler(ItemAccess itemAccess,
 DataComponentType<ItemContainerContents> component,
 int size)

Method Details

getContents

protected ItemContainerContents getContents(ItemResource accessResource)

Retrieves the ItemContainerContents from the current resource of the item access.

getStackFromContents

protected ItemStack getStackFromContents(ItemContainerContents contents,
 int slot)

Retrieves a copy of a single stack from the underlying data component, returning ItemStack.EMPTY if the component does not have a slot present.

Parameters:

contents - the existing contents

slot - the target slot

Returns:

a copy of the stack in the target slot

getResourceFrom

protected ItemResource getResourceFrom(ItemResource accessResource,
 int index)

Description copied from class: ItemAccessResourceHandler

Retrieves the resource stored in the current contents of the item access.

Specified by:

getResourceFrom in class ItemAccessResourceHandler<ItemResource>

getAmountFrom

protected int getAmountFrom(ItemResource accessResource,
 int index)

Description copied from class: ItemAccessResourceHandler

Retrieves the amount stored in the current contents of the item access.

Specified by:

getAmountFrom in class ItemAccessResourceHandler<ItemResource>

See Also:

• ResourceHandler.getAmountAsInt(int)

update

protected ItemResource update(ItemResource accessResource,
 int index,
 ItemResource newResource,
 int newAmount)

Description copied from class: ItemAccessResourceHandler

Returns a resource with updated resource and amount.

Specified by:

update in class ItemAccessResourceHandler<ItemResource>

Parameters:

accessResource - current resource, before the update

index - the index at which the resource and amount should be updated

newResource - the new resource, never empty: empty is indicated by a 0 amount

newAmount - the new amount

Returns:

accessResource updated with the new resource and amount, or ItemResource.EMPTY if the new resource or amount cannot be stored

isValid

public boolean isValid(int index,
 ItemResource resource)

Description copied from class: ItemAccessResourceHandler

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

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

• ItemAccessResourceHandler.getCapacityAsLong(int, T), to report a capacity of 0 for invalid items;
• ItemAccessResourceHandler.insert(int, T, int, TransactionContext), to reject items that cannot fit in this handler.

Specified by:

isValid in interface ResourceHandler<ItemResource>

Overrides:

isValid in class ItemAccessResourceHandler<ItemResource>

Parameters:

index - The index to check.

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

Returns:

whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index

See Also:

• ResourceHandler.isValid(int, T)

getCapacity

protected int getCapacity(int index,
 ItemResource resource)

Description copied from class: ItemAccessResourceHandler

Return the maximum capacity of this handler for the passed resource. If the passed resource is empty, an estimate should be returned.

Specified by:

getCapacity in class ItemAccessResourceHandler<ItemResource>

Returns:

The maximum capacity of this handler for the passed resource.

See Also:

• ResourceHandler.getCapacityAsInt(int, T)