Package net.neoforged.neoforge.registries

Class DeferredRegister<T>

java.lang.Object

net.neoforged.neoforge.registries.DeferredRegister<T>

Type Parameters:

T - the base registry type

Direct Known Subclasses:

DeferredAttachmentTypes, DeferredEntityTypes, DeferredRegister.Blocks, DeferredRegister.DataComponents, DeferredRegister.Items

public class DeferredRegister<T>
extends Object

A helper class to aid in registering objects to modded and vanilla registries and provide deferred suppliers to access those objects.

This class maintains a list of all suppliers for entries and registers them during the proper RegisterEvent event, after being registered to an event bus.

Suppliers should return new instances every time they are invoked.

To create an instance of this helper class, use any of the three factory methods: create(Registry, String), create(ResourceKey, String), or create(ResourceLocation, String). There are also specialized subclasses of this helper for Blocks and Items, created through createBlocks(String) and createItems(String) respectively. (Be sure to store the concrete type of those subclasses, rather than storing them generically as DeferredRegister<Block> or DeferredRegister<Item>.)

Here are some common examples for using this class:

 private static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID);
 private static final DeferredRegister.Blocks BLOCKS = DeferredRegister.createBlocks(MODID);
 private static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITIES = DeferredRegister.create(BuiltInRegistries.BLOCK_ENTITY_TYPE, MODID);

 // If you don't care about the actual Block class, use the simple variants
 public static final DeferredBlock<Block> ROCK_BLOCK = BLOCKS.registerSimpleBlock("rock", Block.Properties.create(Material.ROCK));
 public static final DeferredItem<BlockItem> ROCK_ITEM = ITEMS.registerSimpleBlockItem(ROCK_BLOCK, new Item.Properties());

 // Otherwise, use the regular (non-'simple') variants
 public static final DeferredBlock<SpecialRockBlock> SPECIAL_ROCK_BLOCK = BLOCKS.registerBlock("special_rock",
         SpecialRockBlock::new, Block.Properties.create(Material.ROCK));
 // (#registerSimpleBlockItem does not have a non-'simple' variant -- register an item in the usual way)
 public static final DeferredItem<SpecialRockItem> SPECIAL_ROCK_ITEM = ITEMS.register("special_rock",
         () -> new SpecialRockItem(SPECIAL_ROCK_BLOCK.get(), new Item.Properties()))

 // (Can be DeferredHolder<BlockEntityType<?>, BlockEntityType<RockBlockEntity>> if you prefer)
 public static final Supplier<BlockEntityType<RockBlockEntity>> ROCK_BLOCK_ENTITY = BLOCK_ENTITIES.register("rock",
         () -> BlockEntityType.Builder.of(RockBlockEntity::new, ROCK_BLOCK.get()).build(null));

 public ExampleMod(IEventBus modBus) {
     ITEMS.register(modBus);
     BLOCKS.register(modBus);
     BLOCK_ENTITIES.register(modBus);
 }
 

See Also:

• DeferredRegister.Blocks
• DeferredRegister.Items

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeferredRegister.Blocks	Specialized DeferredRegister for Blocks that uses the specialized DeferredBlock as the return type for DeferredRegister.Blocks.register(java.lang.String, java.util.function.Function<net.minecraft.resources.ResourceLocation, ? extends B>).
static class	DeferredRegister.DataComponents	Specialized DeferredRegister for DataComponentTypes.
static class	DeferredRegister.Items	Specialized DeferredRegister for Items that uses the specialized DeferredItem as the return type for DeferredRegister.Items.register(java.lang.String, java.util.function.Function<net.minecraft.resources.ResourceLocation, ? extends I>).
private static class	DeferredRegister.RegistryHolder<V>

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ResourceLocation,ResourceLocation>	aliases
private @Nullable Registry<T>	customRegistry
private final Map<DeferredHolder<T,? extends T>,Supplier<? extends T>>	entries
private final Set<DeferredHolder<T,? extends T>>	entriesView
private final String	namespace
private boolean	registeredEventBus
private @Nullable DeferredRegister.RegistryHolder<T>	registryHolder
private final ResourceKey<? extends Registry<T>>	registryKey
private boolean	seenNewRegistryEvent
private boolean	seenRegisterEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DeferredRegister(ResourceKey<? extends Registry<T>> registryKey, String namespace)

Method Summary

Modifier and Type	Method	Description
void	addAlias(ResourceLocation from, ResourceLocation to)	Adds an alias that maps from the name specified by from to the name specified by to.
private void	addEntries(RegisterEvent event)
private void	addRegistry(NewRegistryEvent event)
static <T> DeferredRegister<T>	create(Registry<T> registry, String namespace)	DeferredRegister factory for modded registries or vanilla registries.
static <T> DeferredRegister<T>	create(ResourceKey<? extends Registry<T>> key, String namespace)	DeferredRegister factory for modded registries or vanilla registries to lookup based on the provided registry key.
static <B> DeferredRegister<B>	create(ResourceLocation registryName, String modid)	DeferredRegister factory for custom forge registries or vanilla registries to lookup based on the provided registry name.
static DeferredRegister.Blocks	createBlocks(String modid)	Factory for a specialized DeferredRegister for Blocks.
static DeferredRegister.DataComponents	createDataComponents(String modid)	Factory for a specialized DeferredRegister for DataComponentTypes.
protected <I extends T> DeferredHolder<T,I>	createHolder(ResourceKey<? extends Registry<T>> registryKey, ResourceLocation key)	Create a DeferredHolder or an inheriting type to be stored.
static DeferredRegister.Items	createItems(String modid)	Factory for a specialized DeferredRegister for Items.
TagKey<T>	createTagKey(String path)	Creates a tag key based on the current namespace and provided path as the location and the registry name linked to this DeferredRegister.
TagKey<T>	createTagKey(ResourceLocation location)	Creates a tag key based on the provided resource location and the registry name linked to this DeferredRegister.
Collection<DeferredHolder<T,? extends T>>	getEntries()
String	getNamespace()	Returns the modid/namespace associated with this deferred register.
Supplier<Registry<T>>	getRegistry()	Returns a supplier for the Registry linked to this deferred register.
ResourceKey<? extends Registry<T>>	getRegistryKey()
ResourceLocation	getRegistryName()
Registry<T>	makeRegistry(Consumer<RegistryBuilder<T>> consumer)	This method is used to configure a custom modded registry.
private Registry<T>	makeRegistry(ResourceLocation registryName, Consumer<RegistryBuilder<T>> consumer)
<I extends T> DeferredHolder<T,I>	register(String name, Function<ResourceLocation,? extends I> func)	Adds a new entry to the list of entries to be registered and returns a DeferredHolder that will be populated with the created entry automatically.
<I extends T> DeferredHolder<T,I>	register(String name, Supplier<? extends I> sup)	Adds a new entry to the list of entries to be registered and returns a DeferredHolder that will be populated with the created entry automatically.
void	register(net.neoforged.bus.api.IEventBus bus)	Adds our event handler to the specified event bus, this MUST be called in order for this class to function.

Methods inherited from class java.lang.Object

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

Field Details

registryKey

private final ResourceKey<? extends Registry<T>> registryKey

namespace

private final String namespace

entries

private final Map<DeferredHolder<T,? extends T>,Supplier<? extends T>> entries

entriesView

private final Set<DeferredHolder<T,? extends T>> entriesView

aliases

private final Map<ResourceLocation,ResourceLocation> aliases

customRegistry

@Nullable
private @Nullable Registry<T> customRegistry

registryHolder

@Nullable
private @Nullable DeferredRegister.RegistryHolder<T> registryHolder

seenRegisterEvent

private boolean seenRegisterEvent

seenNewRegistryEvent

private boolean seenNewRegistryEvent

registeredEventBus

private boolean registeredEventBus

Constructor Details

DeferredRegister

protected DeferredRegister(ResourceKey<? extends Registry<T>> registryKey,
 String namespace)

Method Details

create

public static <T> DeferredRegister<T> create(Registry<T> registry,
 String namespace)

DeferredRegister factory for modded registries or vanilla registries.

If the registry is never created, any DeferredHolders made from this DeferredRegister will throw an exception.

Parameters:

registry - the registry to register to

namespace - the namespace for all objects registered to this DeferredRegister

See Also:

• create(ResourceKey, String)
• create(ResourceLocation, String)
• createItems(String)
• createBlocks(String)

create

public static <T> DeferredRegister<T> create(ResourceKey<? extends Registry<T>> key,
 String namespace)

DeferredRegister factory for modded registries or vanilla registries to lookup based on the provided registry key. Supports both registries that already exist or do not exist yet.

If the registry is never created, any DeferredHolders made from this DeferredRegister will throw an exception.

Parameters:

key - the key of the registry to reference. May come from another DeferredRegister through getRegistryKey().

namespace - the namespace for all objects registered to this DeferredRegister

See Also:

• create(Registry, String)
• create(ResourceLocation, String)
• createItems(String)
• createBlocks(String)

create

public static <B> DeferredRegister<B> create(ResourceLocation registryName,
 String modid)

DeferredRegister factory for custom forge registries or vanilla registries to lookup based on the provided registry name. Supports both registries that already exist or do not exist yet.

If the registry is never created, any DeferredHolders made from this DeferredRegister will throw an exception.

Parameters:

registryName - The name of the registry, should include namespace. May come from another DeferredRegister through getRegistryName().

modid - The namespace for all objects registered to this DeferredRegister

See Also:

• create(Registry, String)
• create(ResourceKey, String)
• createItems(String)
• createBlocks(String)

createItems

public static DeferredRegister.Items createItems(String modid)

Factory for a specialized DeferredRegister for Items.

Parameters:

modid - The namespace for all objects registered to this DeferredRegister

See Also:

• create(Registry, String)
• create(ResourceKey, String)
• create(ResourceLocation, String)
• createBlocks(String)

createBlocks

public static DeferredRegister.Blocks createBlocks(String modid)

Factory for a specialized DeferredRegister for Blocks.

Parameters:

modid - The namespace for all objects registered to this DeferredRegister

See Also:

• create(Registry, String)
• create(ResourceKey, String)
• create(ResourceLocation, String)
• createItems(String)

createDataComponents

public static DeferredRegister.DataComponents createDataComponents(String modid)

Factory for a specialized DeferredRegister for DataComponentTypes.

Parameters:

modid - The namespace for all objects registered to this DeferredRegister

See Also:

• create(Registry, String)
• create(ResourceKey, String)
• create(ResourceLocation, String)
• createItems(String)

register

public <I extends T> DeferredHolder<T,I> register(String name,
 Supplier<? extends I> sup)

Adds a new entry to the list of entries to be registered and returns a DeferredHolder that will be populated with the created entry automatically.

Parameters:

name - The new entry's name. It will automatically have the namespace prefixed.

sup - A factory for the new entry. The factory should not cache the created entry.

Returns:

A DeferredHolder that will track updates from the registry for this entry.

register

public <I extends T> DeferredHolder<T,I> register(String name,
 Function<ResourceLocation,? extends I> func)

Adds a new entry to the list of entries to be registered and returns a DeferredHolder that will be populated with the created entry automatically.

Parameters:

name - The new entry's name. It will automatically have the namespace prefixed.

func - A factory for the new entry. The factory should not cache the created entry.

Returns:

A DeferredHolder that will track updates from the registry for this entry.

createHolder

protected <I extends T> DeferredHolder<T,I> createHolder(ResourceKey<? extends Registry<T>> registryKey,
 ResourceLocation key)

Create a DeferredHolder or an inheriting type to be stored.

Type Parameters:

I - The specific type of the entry.

Parameters:

registryKey - The key of the registry.

key - The resource location of the entry.

Returns:

The new instance of DeferredHolder or an inheriting type.

makeRegistry

public Registry<T> makeRegistry(Consumer<RegistryBuilder<T>> consumer)

This method is used to configure a custom modded registry. It can only be invoked by a single DeferredRegister instance for a given registry key.

Parameters:

consumer - A consumer that configures the provided RegistryBuilder during NewRegistryEvent

Returns:

The Registry linked to getRegistryKey().

getRegistry

public Supplier<Registry<T>> getRegistry()

Returns a supplier for the Registry linked to this deferred register. For vanilla registries, this will always return a non-null registry. For modded registries, a non-null registry will only be returned after NewRegistryEvent fires, or if makeRegistry(Consumer) is called on this same DeferredRegister instance.

To register additional DeferredRegisters for custom modded registries, use create(ResourceKey, String) which can take a registry key from getRegistryKey().

createTagKey

public TagKey<T> createTagKey(String path)

Creates a tag key based on the current namespace and provided path as the location and the registry name linked to this DeferredRegister. To control the namespace, use createTagKey(ResourceLocation).

See Also:

• createTagKey(ResourceLocation)

createTagKey

public TagKey<T> createTagKey(ResourceLocation location)

Creates a tag key based on the provided resource location and the registry name linked to this DeferredRegister. To use the current namespace as the tag key namespace automatically, use createTagKey(String).

See Also:

• createTagKey(String)

addAlias

public void addAlias(ResourceLocation from,
 ResourceLocation to)

Adds an alias that maps from the name specified by from to the name specified by to.

Any registry lookups that target the first name will resolve as the second name, if the first name is not present.

Parameters:

from - The source registry name to alias from.

to - The target registry name to alias to.

register

public void register(net.neoforged.bus.api.IEventBus bus)

Adds our event handler to the specified event bus, this MUST be called in order for this class to function. See the example usage.

Parameters:

bus - The Mod Specific event bus.

getEntries

public Collection<DeferredHolder<T,? extends T>> getEntries()

Returns:

The unmodifiable view of registered entries. Useful for bulk operations on all values.

getRegistryKey

public ResourceKey<? extends Registry<T>> getRegistryKey()

Returns:

The registry key stored in this deferred register. Useful for creating new deferred registers based on an existing one.

getRegistryName

public ResourceLocation getRegistryName()

Returns:

The registry name stored in this deferred register. Useful for creating new deferred registers based on an existing one.

getNamespace

public String getNamespace()

Returns the modid/namespace associated with this deferred register.

Returns:

the modid/namespace associated with this deferred register

makeRegistry

private Registry<T> makeRegistry(ResourceLocation registryName,
 Consumer<RegistryBuilder<T>> consumer)

addEntries

private void addEntries(RegisterEvent event)

addRegistry

private void addRegistry(NewRegistryEvent event)