net.minecraftforge.registries.DeferredRegister<T>

Type Parameters:: T - The base registry type

public class DeferredRegister<T> extends Object

Utility class to help with managing registry entries. Maintains a list of all suppliers for entries and registers them during the proper Register event. Suppliers should return NEW instances every time. Example Usage:


   private static final DeferredRegister<Item> ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, MODID);
   private static final DeferredRegister<Block> BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID);

   public static final RegistryObject<Block> ROCK_BLOCK = BLOCKS.register("rock", () -> new Block(Block.Properties.create(Material.ROCK)));
   public static final RegistryObject<Item> ROCK_ITEM = ITEMS.register("rock", () -> new BlockItem(ROCK_BLOCK.get(), new Item.Properties().group(ItemGroup.MISC)));

   public ExampleMod() {
       ITEMS.register(FMLJavaModLoadingContext.get().getModEventBus());
       BLOCKS.register(FMLJavaModLoadingContext.get().getModEventBus());
   }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

private class

DeferredRegister.EventDispatcher

private static class

DeferredRegister.RegistryHolder<V>

Deprecated, for removal: This API element is subject to removal in a future version.
Field Summary

Fields

Modifier and Type

Field

Description

private final Map<RegistryObject<T>,Supplier<? extends T>>

entries

private final Set<RegistryObject<T>>

entriesView

private final String

modid

private final boolean

optionalRegistry

private @Nullable com.google.common.collect.SetMultimap<TagKey<T>,Supplier<T>>

optionalTags

private @Nullable Supplier<RegistryBuilder<?>>

registryFactory

private final ResourceKey<? extends Registry<T>>

registryKey

private boolean

seenRegisterEvent
Constructor Summary

Constructors

Modifier

Constructor

Description

private

DeferredRegister(ResourceKey<? extends Registry<T>> registryKey, String modid, boolean optionalRegistry)

private

DeferredRegister(IForgeRegistry<T> reg, String modid)
Method Summary

Modifier and Type

Method

Description

void

addOptionalTagDefaults(@NotNull TagKey<T> name, @NotNull Set<? extends Supplier<T>> defaults)

Adds defaults to an existing tag key.

static DeferredRegister

create(Supplier<IForgeRegistry> reg, String modid)

DeferredRegister factory for forge registries that exist after this DeferredRegister is created.

static DeferredRegister

create(ResourceKey<? extends Registry> key, String modid)

DeferredRegister factory for custom forge registries or vanilla registries to lookup based on the provided registry key.

static DeferredRegister

create(ResourceLocation registryName, String modid)

DeferredRegister factory for custom forge registries or vanilla registries to lookup based on the provided registry name.

static DeferredRegister

create(IForgeRegistry reg, String modid)

DeferredRegister factory for forge registries that exist before this DeferredRegister is created.

static DeferredRegister

createOptional(ResourceKey<? extends Registry> key, String modid)

DeferredRegister factory for the optional existence of custom forge registries or vanilla registries to lookup based on the provided registry key.

static DeferredRegister

createOptional(ResourceLocation registryName, String modid)

DeferredRegister factory for the optional existence of custom forge registries or vanilla registries to lookup based on the provided registry name.

@NotNull TagKey<T>

createOptionalTagKey(@NotNull String path, @NotNull Set<? extends Supplier<T>> defaults)

Creates a tag key with the current modid and provided path that will use the set of defaults if the tag is not loaded from any datapacks.

@NotNull TagKey<T>

createOptionalTagKey(@NotNull ResourceLocation location, @NotNull Set<? extends Supplier<T>> defaults)

Creates a tag key with the provided location that will use the set of defaults if the tag is not loaded from any datapacks.

@NotNull TagKey<T>

createTagKey(@NotNull String path)

Creates a tag key based on the current modid and provided path as the location and the registry name linked to this DeferredRegister.

@NotNull TagKey<T>

createTagKey(@NotNull ResourceLocation location)

Creates a tag key based on the provided resource location and the registry name linked to this DeferredRegister.

Collection<RegistryObject<T>>

getEntries()

ResourceKey<? extends Registry<T>>

getRegistryKey()

@NotNull ResourceLocation

getRegistryName()

Supplier<IForgeRegistry<T>>

makeRegistry(Supplier<RegistryBuilder<T>> sup)

Only used for custom registries to fill the forge registry held in this DeferredRegister.

private Supplier<IForgeRegistry<T>>

makeRegistry(ResourceLocation registryName, Supplier<RegistryBuilder<T>> sup)

private void

onFill(IForgeRegistry<?> registry)

 RegistryObject

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

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

void

register(net.minecraftforge.eventbus.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
- modid
 
 private final String modid
- optionalRegistry
 
 private final boolean optionalRegistry
- entries
 
 private final Map<RegistryObject<T>,Supplier<? extends T>> entries
- entriesView
 
 private final Set<RegistryObject<T>> entriesView
- registryFactory
 
 @Nullable private @Nullable Supplier<RegistryBuilder<?>> registryFactory
- optionalTags
 
 @Nullable private @Nullable com.google.common.collect.SetMultimap<TagKey<T>,Supplier<T>> optionalTags
- seenRegisterEvent
 
 private boolean seenRegisterEvent
Constructor Details
- DeferredRegister
 
 private DeferredRegister(ResourceKey<? extends Registry<T>> registryKey, String modid, boolean optionalRegistry)
- DeferredRegister
 
 private DeferredRegister(IForgeRegistry<T> reg, String modid)
Method Details
- create
 
 public static DeferredRegister create(IForgeRegistry reg, String modid)
 
 DeferredRegister factory for forge registries that exist before this DeferredRegister is created.
 If you have a supplier, do not use this method. Instead, use one of the other factories that takes in a registry key or registry name.
 Parameters:
 
 reg - the forge registry to wrap
 
 modid - the namespace for all objects registered to this DeferredRegister
 
 See Also:
 
 create(ResourceKey, String)
 
 create(ResourceLocation, String)
- create
 
 public static DeferredRegister create(@Deprecated(forRemoval=true,since="1.20.2") Supplier<IForgeRegistry> reg, String modid)
 
 DeferredRegister factory for forge registries that exist after this DeferredRegister is created.
 Parameters:
 
 reg - the forge registry to wrap
 
 modid - the namespace for all objects registered to this DeferredRegister
 
 See Also:
 
 create(ResourceKey, String)
 
 create(ResourceLocation, String)
- create
 
 public static DeferredRegister create(ResourceKey<? extends Registry> key, String modid)
 
 DeferredRegister factory for custom forge 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 RegistryObjects made from this DeferredRegister will throw an exception. To allow the optional existence of a registry without error, use createOptional(ResourceKey, String).
 Parameters:
 
 key - the key of the registry to reference. May come from another DeferredRegister through getRegistryKey().
 
 modid - the namespace for all objects registered to this DeferredRegister
 
 See Also:
 
 createOptional(ResourceKey, String)
 
 create(IForgeRegistry, String)
 
 create(ResourceLocation, String)
- createOptional
 
 public static DeferredRegister createOptional(ResourceKey<? extends Registry> key, String modid)
 
 DeferredRegister factory for the optional existence of custom forge 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 RegistryObjects made from this DeferredRegister will never be filled but will not throw an exception.
 Parameters:
 
 key - the key of the registry to reference
 
 modid - the namespace for all objects registered to this DeferredRegister
 
 See Also:
 
 create(ResourceKey, String)
 
 create(IForgeRegistry, String)
 
 create(ResourceLocation, String)
- create
 
 public static DeferredRegister 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 RegistryObjects made from this DeferredRegister will throw an exception. To allow the optional existence of a registry without error, use createOptional(ResourceLocation, String).
 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:
 
 createOptional(ResourceLocation, String)
 
 create(IForgeRegistry, String)
 
 create(ResourceKey, String)
- createOptional
 
 public static DeferredRegister createOptional(ResourceLocation registryName, String modid)
 
 DeferredRegister factory for the optional existence of 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 RegistryObjects made from this DeferredRegister will never be filled but will not 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(ResourceLocation, String)
 
 create(IForgeRegistry, String)
 
 create(ResourceKey, String)
- register
 
 public RegistryObject register(String name, Supplier<? extends I> sup)
 
 Adds a new supplier to the list of entries to be registered, and returns a RegistryObject that will be populated with the created entry automatically.
 
 Parameters:
 
 name - The new entry's name, it will automatically have the modid prefixed.
 
 sup - A factory for the new entry, it should return a new instance every time it is called.
 
 Returns:
 
 A RegistryObject that will be updated with when the entries in the registry change.
- makeRegistry
 
 public Supplier<IForgeRegistry<T>> makeRegistry(Supplier<RegistryBuilder<T>> sup)
 
 Only used for custom registries to fill the forge registry held in this DeferredRegister. Calls RegistryBuilder.setName(net.minecraft.resources.ResourceLocation) automatically.
 
 Parameters:
 
 sup - Supplier of a RegistryBuilder that initializes a IForgeRegistry during the NewRegistryEvent event
 
 Returns:
 
 A supplier of the IForgeRegistry created by the builder. Will always return null until after the NewRegistryEvent event fires.
- createTagKey
 
 @NotNull public @NotNull TagKey<T> createTagKey(@NotNull @NotNull String path)
 
 Creates a tag key based on the current modid and provided path as the location and the registry name linked to this DeferredRegister. To control the namespace, use createTagKey(ResourceLocation).
 Throws:
 
 IllegalStateException - If the registry name was not set. Use the factories that take a registry name or forge registry.
 
 See Also:
 
 createTagKey(ResourceLocation)
 
 createOptionalTagKey(String, Set)
- createTagKey
 
 @NotNull public @NotNull TagKey<T> createTagKey(@NotNull @NotNull ResourceLocation location)
 
 Creates a tag key based on the provided resource location and the registry name linked to this DeferredRegister. To use the current modid as the namespace, use createTagKey(String).
 Throws:
 
 IllegalStateException - If the registry name was not set. Use the factories that take a registry name or forge registry.
 
 See Also:
 
 createTagKey(String)
 
 createOptionalTagKey(ResourceLocation, Set)
- createOptionalTagKey
 
 @NotNull public @NotNull TagKey<T> createOptionalTagKey(@NotNull @NotNull String path, @NotNull @NotNull Set<? extends Supplier<T>> defaults)
 
 Creates a tag key with the current modid and provided path that will use the set of defaults if the tag is not loaded from any datapacks. Useful on the client side when a server may not provide a specific tag. To control the namespace, use createOptionalTagKey(ResourceLocation, Set).
 Throws:
 
 IllegalStateException - If the registry name was not set. Use the factories that take a registry name or forge registry.
 
 See Also:
 
 createTagKey(String)
 
 createTagKey(ResourceLocation)
 
 createOptionalTagKey(ResourceLocation, Set)
 
 addOptionalTagDefaults(TagKey, Set)
- createOptionalTagKey
 
 @NotNull public @NotNull TagKey<T> createOptionalTagKey(@NotNull @NotNull ResourceLocation location, @NotNull @NotNull Set<? extends Supplier<T>> defaults)
 
 Creates a tag key with the provided location that will use the set of defaults if the tag is not loaded from any datapacks. Useful on the client side when a server may not provide a specific tag. To use the current modid as the namespace, use createOptionalTagKey(String, Set).
 Throws:
 
 IllegalStateException - If the registry name was not set. Use the factories that take a registry name or forge registry.
 
 See Also:
 
 createTagKey(String)
 
 createTagKey(ResourceLocation)
 
 createOptionalTagKey(String, Set)
 
 addOptionalTagDefaults(TagKey, Set)
- addOptionalTagDefaults
 
 public void addOptionalTagDefaults(@NotNull @NotNull TagKey<T> name, @NotNull @NotNull Set<? extends Supplier<T>> defaults)
 
 Adds defaults to an existing tag key. The set of defaults will be bound to the tag if the tag is not loaded from any datapacks. Useful on the client side when a server may not provide a specific tag.
 Throws:
 
 IllegalStateException - If the registry name was not set. Use the factories that take a registry name or forge registry.
 
 See Also:
 
 createOptionalTagKey(String, Set)
 
 createOptionalTagKey(ResourceLocation, Set)
- register
 
 public void register(net.minecraftforge.eventbus.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<RegistryObject<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
 
 @NotNull public @NotNull ResourceLocation getRegistryName()
 
 Returns:
 
 The registry name stored in this deferred register. Useful for creating new deferred registers based on an existing one.
- makeRegistry
 
 private Supplier<IForgeRegistry<T>> makeRegistry(ResourceLocation registryName, Supplier<RegistryBuilder<T>> sup)
- onFill
 
 private void onFill(IForgeRegistry<?> registry)

Class DeferredRegister<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

registryKey

modid

optionalRegistry

entries

entriesView

registryFactory

optionalTags

seenRegisterEvent

Constructor Details

DeferredRegister

DeferredRegister

Method Details

create

create

create

createOptional

create

createOptional

register

makeRegistry

createTagKey

createTagKey

createOptionalTagKey

createOptionalTagKey

addOptionalTagDefaults

register

getEntries

getRegistryKey

getRegistryName

makeRegistry

onFill