Package net.neoforged.neoforge.capabilities

Class CapabilityRegistry<C>

java.lang.Object

net.neoforged.neoforge.capabilities.CapabilityRegistry<C>

public class CapabilityRegistry<C>
extends Object

Helper class to manage registering capabilities. You only need this if you are creating your own type (block, entity, item...) of capabilities!

Look at the source code of BlockCapability, EntityCapability, ... for an example.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapabilityRegistry.CapabilityConstructor<C>
private static final record	CapabilityRegistry.StoredCap<C>

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentMap<ResourceLocation,CapabilityRegistry.StoredCap<C>>	caps
private final CapabilityRegistry.CapabilityConstructor<C>	constructor

Constructor Summary

Constructors

Constructor	Description
CapabilityRegistry(CapabilityRegistry.CapabilityConstructor<C> constructor)

Method Summary

Modifier and Type	Method	Description
C	create(ResourceLocation name, Class<?> typeClass, Class<?> contextClass)	Creates a new capability with the given name, type class and context class, or returns an existing one if it was already created.
List<C>	getAll()	Returns an immutable copy of all the currently known capabilities.

Methods inherited from class java.lang.Object

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

Field Details

caps

private final ConcurrentMap<ResourceLocation,CapabilityRegistry.StoredCap<C>> caps

constructor

private final CapabilityRegistry.CapabilityConstructor<C> constructor

Constructor Details

CapabilityRegistry

public CapabilityRegistry(CapabilityRegistry.CapabilityConstructor<C> constructor)

Method Details

create

public C create(ResourceLocation name,
 Class<?> typeClass,
 Class<?> contextClass)

Creates a new capability with the given name, type class and context class, or returns an existing one if it was already created.

Parameters:

name - name of the capability

typeClass - class of the queried object

contextClass - class of the additional context

Throws:

IllegalStateException - if a capability with the same name but different type or context class was already created

getAll

public List<C> getAll()

Returns an immutable copy of all the currently known capabilities.