Package net.neoforged.neoforge.transfer

Class ResourceStacksResourceHandler<R extends Resource>

java.lang.Object

net.neoforged.neoforge.transfer.StacksResourceHandler<ResourceStack<R>,R>

net.neoforged.neoforge.transfer.ResourceStacksResourceHandler<R>

All Implemented Interfaces:

ValueIOSerializable, ResourceHandler<R>

public abstract class ResourceStacksResourceHandler<R extends Resource>
extends StacksResourceHandler<ResourceStack<R>,R>

Base implementation of a ResourceHandler backed by a list of ResourceStacks.

The following methods will typically be overridden:

• (optional) StacksResourceHandler.isValid(int, T) to limit which resources are allowed in this handler; by default any resource is allowed.
• (required) StacksResourceHandler.getCapacity(int, T) to specify the capacity of this handler.
• (recommended) StacksResourceHandler.onContentsChanged(int, S) to react to changes in this handler, for example to trigger setChanged().

See Also:

• StacksResourceHandler

Field Summary

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

codec, emptyStack, stacks, VALUE_IO_KEY

Constructor Summary

Constructors

Constructor	Description
ResourceStacksResourceHandler(int size, R emptyResource, com.mojang.serialization.Codec<ResourceStack<R>> stackCodec)
ResourceStacksResourceHandler(NonNullList<ResourceStack<R>> stacks, R emptyResource, com.mojang.serialization.Codec<ResourceStack<R>> stackCodec)

Method Summary

Modifier and Type	Method	Description
protected ResourceStack<R>	copyOf(ResourceStack<R> stack)	Creates a copy of a stack, for use as a snapshot.
int	getAmountFrom(ResourceStack<R> stack)	Retrieves the amount from a stack.
R	getResourceFrom(ResourceStack<R> stack)	Retrieves the resource from a stack.
protected ResourceStack<R>	getStackFrom(R resource, int amount)	Creates a stack from a resource and an amount.
boolean	matches(ResourceStack<R> stack, R resource)	Checks if the passed resource corresponds to the stack.

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

copyToList, deserialize, extract, getAmountAsLong, getCapacity, getCapacityAsLong, getResource, insert, isValid, onContentsChanged, serialize, set, 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

Constructor Details

ResourceStacksResourceHandler

public ResourceStacksResourceHandler(int size,
 R emptyResource,
 com.mojang.serialization.Codec<ResourceStack<R>> stackCodec)

ResourceStacksResourceHandler

public ResourceStacksResourceHandler(NonNullList<ResourceStack<R>> stacks,
 R emptyResource,
 com.mojang.serialization.Codec<ResourceStack<R>> stackCodec)

Method Details

getResourceFrom

public R getResourceFrom(ResourceStack<R> stack)

Description copied from class: StacksResourceHandler

Retrieves the resource from a stack. In the case of an ItemStack an ItemResource would be returned for example.

Specified by:

getResourceFrom in class StacksResourceHandler<ResourceStack<R extends Resource>,R extends Resource>

getAmountFrom

public int getAmountFrom(ResourceStack<R> stack)

Description copied from class: StacksResourceHandler

Retrieves the amount from a stack. In the case of an ItemStack the count would be returned for example.

Specified by:

getAmountFrom in class StacksResourceHandler<ResourceStack<R extends Resource>,R extends Resource>

getStackFrom

protected ResourceStack<R> getStackFrom(R resource,
 int amount)

Description copied from class: StacksResourceHandler

Creates a stack from a resource and an amount.

If the stack would be empty, consider returning StacksResourceHandler.emptyStack instead of creating a new empty stack instance.

Specified by:

getStackFrom in class StacksResourceHandler<ResourceStack<R extends Resource>,R extends Resource>

copyOf

protected ResourceStack<R> copyOf(ResourceStack<R> stack)

Description copied from class: StacksResourceHandler

Creates a copy of a stack, for use as a snapshot.

If using an immutable stack type such as ResourceStack, it can be returned as is. In the case of a mutable stack type such as an item or fluid stack, a copy should be returned.

Specified by:

copyOf in class StacksResourceHandler<ResourceStack<R extends Resource>,R extends Resource>

matches

public boolean matches(ResourceStack<R> stack,
 R resource)

Description copied from class: StacksResourceHandler

Checks if the passed resource corresponds to the stack.

Overrides:

matches in class StacksResourceHandler<ResourceStack<R extends Resource>,R extends Resource>

Parameters:

stack - the stack, usually the current stored value

resource - the resource, usually the received value in insert or extract

Returns:

true if the stack and resource match; false otherwise.