Registration

From Forge Community Wiki

Registration is the process of making an object (such as an item or block) known to the game during runtime with an attached ResourceLocation name. Unregistered objects are a likely cause of game loading crashes or bugs, so it is important to register objects correctly.

Most objects that are known within the game are handled by a Vanilla Registry or a Forge IForgeRegistry. Each registry uniquely defines each of its own objects through a "registry name" via a ResourceLocation. Registries themselves have a name and are registered to the Vanilla root registry or RegistryManager. It is important to keep these distinct; although both are called registry names.

In a global context, each object is universally unique through its ResourceKey: a concatenation of its registry's id and the object's registry name.

Forge expands Vanilla's registries to add important features for modded environments, such as world saving of integer ids and network syncing of integer ids, to ensure consistency when different mods and entries are present.

Forge registries preserves the same loading order of Vanilla registries, with all modded registries fired after Vanilla in alphabetical order by string comparing namespace then path. This loading order determines what order registries have their entries registered. All registries wrapped by Forge can be found within the ForgeRegistries class.

All registries have their own set of names and objects, so the same name (e.g. examplemod:object) can be reused in multiple registries, like blocks and items.

Warning

If two registry objects within the same registry have the same name, the second object will override the first.

Methods for Registering

There are two proper ways to register objects to a Forge registry or Vanilla registry: the DeferredRegister class, and the RegisterEvent lifecycle event.

DeferredRegister

DeferredRegister is an abstraction layer over the registry event used to register objects. It maintains a map of "registry name" to their associated suppliers and resolves those suppliers during RegisterEvent for the associated registry. This method is the currently recommended, and documented, way to handle these objects as it provides convenience and safety for those who want to statically initialize objects while avoiding some issues associated with it.

Important

When using DeferredRegisters with non-vanilla registries, the registry key or the registry name should be supplied to the create method. These include the custom Forge registries for entity data serializers, global loot modifier serializers, world presets, and biome modifier serializers. Calling Supplier#get on a Supplier<IForgeRegistry<?>> when making a DeferredRegister will return null because the registry does not exist yet.

An example of a mod registering a custom block:

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

public static final RegistryObject<Block> EXAMPLE_BLOCK = BLOCKS.register("example_block", () -> new Block(BlockBehaviour.Properties.of(Material.STONE)));

public ExampleMod() {
    BLOCKS.register(FMLJavaModLoadingContext.get().getModEventBus());
}
private val BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID)

val EXAMPLE_BLOCK: RegistryObject<Block> = BLOCKS.register("example_block") { Block(BlockBehaviour.Properties.of(Material.ROCK)) }

internal class ExampleMod {
    init {
        BLOCKS.register(FMLJavaModLoadingContext.get().modEventBus)
    }
}
object ExampleMod {
    private final val BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID)

    final val EXAMPLE_BLOCK = registerBlock("example_block", () => new Block(BlockBehaviour.Properties.of(Material.ROCK)))
}
class ExampleMod {
    BLOCKS.register(FMLJavaModLoadingContext.get.getModEventBus)
}
private static final DeferredRegister<Block> BLOCKS = DeferredRegister.create(ForgeRegistries.BLOCKS, MODID);

public static final RegistryObject<Block> EXAMPLE_BLOCK = BLOCKS.register("example_block", () -> new Block(BlockBehaviour.Properties.of(Material.STONE)));

ExampleMod() {
    BLOCKS.register(FMLJavaModLoadingContext.get().modEventBus);
}
When using a DeferredRegister to register any object, the name inputted will be automatically prefixed with the mod id passed in, giving the above object a "registry name" of examplemod:example_block.

RegisterEvent

The RegisterEvent is the second way register objects. This event is fired for each registry synchronously in vanilla registry order after FMLConstructModEvent and before the configs are loaded. Objects are registered using #register by passing in the registry key, the name of the registry object, and the object itself. There is an additional #register overload which takes in a consumed helper to register an object with a given name. It is recommended to use this method to avoid unnecessary object creation.

Here is an example: (the event handler is registered on the mod event bus)

@SubscribeEvent
public void register(RegisterEvent event) {
    event.register(ForgeRegistries.Keys.BLOCKS,
        helper -> helper.register(new ResourceLocation(MODID, "example_block"), new Block(...))
    );
}
@JvmStatic
@SubscribeEvent
private fun register(event: RegisterEvent) =
    event.register(ForgeRegistries.Keys.BLOCKS) {
        helper -> helper.register(ResourceLocation(MODID, "example_block"), Block(...))
    }
@SubscribeEvent
def register(event: RegisterEvent): Unit =
    event.register(ForgeRegistries.Keys.BLOCKS,
        helper => helper.register(new ResourceLocation(MODID, "example_block"), new Block(...))
    )

Important

Since all objects registered must be singleton, some classes cannot by themselves be registered. Instead, *Type classes are registered and used in the formers' constructors to wrap the flyweight objects. For example, a BlockEntity is wrapped via BlockEntityType, and Entity is wrapped via EntityType. These *Type classes hold factories that simply create the containing type on demand.

These factory holders are created through the use of their *Type$Builder classes. An example: (REGISTER here refers to a DeferredRegister<BlockEntityType<?>>)

public static final RegistryObject<BlockEntityType<ExampleBlockEntity>> EXAMPLE_BLOCK_ENTITY = REGISTER.register(
    "example_block_entity", () -> BlockEntityType.Builder.of(ExampleBlockEntity::new, EXAMPLE_BLOCK.get()).build(null)
);
val EXAMPLE_BLOCK_ENTITY: RegistryObject<BlockEntityType<ExampleBlockEntity>> = REGISTER.register("example_block_entity") { BlockEntityType.Builder.of(::ExampleBlockEntity, EXAMPLE_BLOCK.get()).build(null)) }
final val EXAMPLE_BLOCK_ENTITY = REGISTER.register("example_block_entity", () => BlockEntityType.Builder.of(() => new ExampleBlockEntity(), GeneralRegistrar.EXAMPLE_BLOCK.get).build(null))

Non-Forge Registries

Not all vanilla registries are wrapped as a Forge registry. To register objects to any one of these registries, create a DeferredRegister via the #create overload which takes in a resource key of the registry and the mod id to register the entries for. Then simply call #register like any other DeferredRegister.

private static final DeferredRegister<LootItemConditionType> REGISTER = DeferredRegister.create(Registry.LOOT_ITEM_REGISTRY, MODID);

public static final RegistryObject<LootItemConditionType> EXAMPLE_LOOT_ITEM_CONDITION_TYPE = REGISTER.register("example_loot_item_condition_type", () -> new LootItemConditionType(...));
private val REGISTER = DeferredRegister.create(Registry.LOOT_ITEM_REGISTRY, MODID)

val EXAMPLE_LOOT_ITEM_CONDITION_TYPE : RegistryObject<LootItemConditionType> = REGISTER.register("example_loot_item_condition_type") {
    LootItemConditionType(...)
}
private final val REGISTER = DeferredRegister.create(Registry.LOOT_ITEM_REGISTRY, MODID)

final val EXAMPLE_LOOT_ITEM_CONDITION_TYPE = REGISTER.register("example_loot_item_condition_type", () => new LootItemConditionType(...))
private static final DeferredRegister<LootItemConditionType> REGISTER = DeferredRegister.create(Registry.LOOT_ITEM_REGISTRY, MODID);

public static final RegistryObject<LootItemConditionType> EXAMPLE_LOOT_ITEM_CONDITION_TYPE = REGISTER.register("example_loot_item_condition_type", () -> new LootItemConditionType(...));

If you attempt to make one of these instances require an instance of another registry object, you should use the lazy initialization method mentioned above to register the object in the correct order.

Data Driven Entries

Registries are considered to be data driven if they are located within RegistryAccess with the exception of LevelStem and Level.

These registry objects only need to be registered within code if they are to be used within a pre-existing registry object (e.g. a PlacedFeature for ore generation within an overworld Biome). Otherwise, their instance can be purely registered using a JSON file.

If a data driven registry object has to be registered within code, a dummy object should be supplied to hold a "registry name" and then constructed within a JSON file.

Referencing Registered Objects

Each forge registered object should not be statically initialized nor reference another instance being registered. They must always be a new, singleton instance that is resolved during when RegisterEvent is called for their registry. This is to maintain a sane loading order for registries and their objects along with dynamic loading/unloading of mods.

Forge registered objects must always be referenced through a RegistryObject or a field with @ObjectHolder.

Using RegistryObjects

RegistryObjects can be used to retrieve references to registered objects once they become available. Their references are updated along with all @ObjectHolder annotations after the registry that RegisterEvent is called for is dispatched and frozen.

A RegistryObject can be retrieved as a result of using DeferredRegister or calling the static factory RegistryObject#create. Each static factory takes in the "registry name" of the object being referenced and one of the following: a IForgeRegistry, a registry name of the type ResourceLocation, or a registry key of the type ResourceKey<? extends Registry<?>>. The RegistryObject can be stored within some field and retrieve the registered object using #get.

An example using RegistryObject:

public static final RegistryObject<Item> EXAMPLE_ITEM = RegistryObject.create(new ResourceLocation("examplemod", "example_item"), ForgeRegistries.ITEMS);

// Assume that 'examplemod:example_registry' is a valid registry, and 'examplemod:example_object' is a valid object within that registry
public static final RegistryObject<ExampleRegistry> EXAMPLE_OBJECT = RegistryObject.create(new ResourceLocation("examplemod", "example_object"), new ResourceLocation("examplemod", "example_registry"), "examplemod");
val EXAMPLE_ITEM: RegistryObject<Item> = RegistryObject.create(ResourceLocation("examplemod", "example_item"), ForgeRegistries.ITEMS)

// Assume that 'examplemod:example_registry' is a valid registry, and 'examplemod:example_object' is a valid object within that registry
val EXAMPLE_OBJECT: RegistryObject<ExampleRegistry> = RegistryObject.create(ResourceLocation("examplemod", "example_object"), new ResourceLocation("examplemod", "example_registry"), "examplemod")
final val EXAMPLE_ITEM = RegistryObject.create(new ResourceLocation("examplemod", "example_item"), ForgeRegistries.ITEMS)

// Assume that 'examplemod:example_registry' is a valid registry, and 'examplemod:example_object' is a valid object within that registry
final val EXAMPLE_OBJECT = RegistryObject.create(new ResourceLocation("examplemod", "example_object"), new ResourceLocation("examplemod", "example_registry"), "examplemod");

Important

All vanilla objects are bootstrapped and registered before mods are loaded. As such, they can be referenced as is without any issues.

Using @ObjectHolder

Forge registry objects can also be injected into public static final fields by annotating each field with @ObjectHolder. Note that using RegistryObjects is the preferred strategy as ObjectHolders are verbose, clunky, and easy to mess up.

ObjectHolders can only be applied to fields and require 2 pieces of information: the registry name of your target registry and the name of your object entry inside the registry.

The registry name can be found inside of ForgeRegistries.Keys or Registry. For blocks, this would be "minecraft:block". For items, this would be "minecraft:item", etc.

The name of your entry is dependent on what you called it and requires your modid to be prefixed. When using @ObjectHolder inside of your main mod class annotated with @Mod, the modid namespace can be omitted.

The rules for @ObjectHolder are as follows:

  • If the class is annotated with @Mod, the modid will be the default namespace for all annotated fields within if not explicitly defined
  • A field is considered for injection if:
    • it has at least the modifiers public static and optionally final, and
    • the field is annotated with @ObjectHolder, and:
      • the entry name value is explicitly defined, and
      • the registry name value is explicitly defined
  • An exception is thrown if the resulting ResourceLocation is incomplete or invalid (non-valid characters in path)
  • If no other errors or exceptions occur, the field will be injected
  • If all of the above rules do not apply, no action will be taken (and a message may be logged)

@ObjectHolder annotated fields are injected with their associated object values after RegisterEvent is fired for their registry, the same time that RegistryObjects are filled. ObjectHolders will remain empty if the associated registry does not exist.

Warning

If the object does not exist in the registry when it is to be injected, a debug message will be logged, and no value will be injected. If the object is found, but the field cannot be set, a warning message will be logged instead.

As these rules are rather complicated, here are some examples:

Example uses of @ObjectHolder
class Holder {
    @ObjectHolder(registryName = "minecraft:enchantment", value = "minecraft:flame")
    public static final Enchantment flame = null;     // Annotation present. [public static] is required. [final] is optional.
                                                      // Registry name is explicitly defined: "minecraft:enchantment"
                                                      // Resource location is explicitly defined: "minecraft:flame"
                                                      // To inject: "minecraft:flame" from the [Enchantment] registry

    public static final Biome ice_flat = null;        // No annotation on the field.
                                                      // Therefore, the field is ignored.

    @ObjectHolder("minecraft:creeper")
    public static final Entity creeper = null;        // Annotation present. [public static] is required. [final] is optional.
                                                      // The registry name has not been specified on the field.
                                                      // Therefore, this will not compile.

    @ObjectHolder(registryName = "minecraft:potion")
    public static final Potion levitation = null;     // Annotation present. [public static] is required. [final] is optional.
                                                      // Registry name is explicitly defined: "minecraft:potion"
                                                      // The entry's name value has not been specified on the field.
                                                      // Therefore, this will not compile.
}

Creating Custom Registries

Creating custom registries for your mod might be useful if you want other mods to add new things to your system. For example, you might have magic spells and want to allow other mods to add new spells. For this you will want to make a registry (eg. "mymagicmod:spells"). This way, other mods will be able to register things to that list, and you won't have to do anything else.

Just like with registering a new item or block you have two ways of making a new registry. Each method takes in a RegistryBuilder which is used to build an IForgeRegistry. Each builder should have its name set via #setName before being created.

With DeferredRegister

The first method involves the second static constructor: DeferredRegister#create(ResourceLocation, String). From there, we can construct the registry using #makeRegistry. This will already populate #setName for us. This method also returns a supplier of the registry which we can use after the NewRegistryEvent is called.

Here is an example:

public static final DeferredRegister<ExampleRegistry> EXAMPLE = DeferredRegister.create(new ResourceLocation(MODID, "example_registry"), MODID);

public static final Supplier<IForgeRegistry<ExampleRegistry>> REGISTRY = EXAMPLE.makeRegistry(RegistryBuilder::new);
val EXAMPLE: DeferredRegister<ExampleRegistry> = DeferredRegister.create(ResourceLocation(MODID, "example_registry"), MODID)

val REGISTRY: IForgeRegistry<ExampleRegistry> by EXAMPLE.makeRegistry(::RegistryBuilder).let {
    lazy {
        it.get()
    }
}
final val EXAMPLE = DeferredRegister.create(new ResourceLocation(MODID, "example_registry"), MODID)

private final val PRIVATE_REGISTRY = EXAMPLE.makeRegistry(() => new RegistryBuilder)
final lazy val REGISTRY = PRIVATE_REGISTRY.get

Using NewRegistryEvent

The second method can be done during the NewRegistryEvent event. Using NewRegistryEvent#create, you can pass in a RegistryBuilder directly. This method will return a Supplier<IForgeRegistry<V>> that can be stored and queried after the event is fired to gain access to your IForgeRegistry instance.

Here is an example: (the event handler is registered on the mod event bus)

public static Supplier<IForgeRegistry<ExampleRegistry>> registrySupplier = null;

@SubscribeEvent
public void onNewRegistry(NewRegistryEvent event){
    RegistryBuilder<ExampleRegistry> registryBuilder = new RegistryBuilder<>();
    registryBuilder.setName(new ResourceLocation(MODID, "example_registry");
    registrySupplier = event.create(registryBuilder);
}

Handling Missing Entries

When loading a pre-existing world after removing mods or updating versions, there are cases where certain registry objects will cease to exist. In these cases, it is possible to specify actions to remove a mapping, prevent the world from loading, or remap the name as needed. This can be done through the third of the registry events: MissingMappingsEvent. Within the event, you can grab an immutable list of missing mappings associated with a mod id for a given registry via #getMappings or a list of all mappings via #getAllMappings.

For each Mapping, you can either execute one of the following methods:

  • #ignore which abandons the entry when loading
  • #warn which warns the user about the missing entry but continues loading
  • #fail which prevents the world from loading
  • #remap which remaps the entry to the specified non-null object in the same registry

If none of the above are specified, then the default action of notifying the user about the missing mappings occur.

Here is an example: (the event handler is registered on the forge event bus)

// This will ignore any missing test items from the specified world
@SubscribeEvent
public void onMissing(final MissingMappingsEvent event) {
    event.getMappings(ForgeRegistries.Keys.ITEMS, MODID).stream()
        .filter(mapping -> mapping.key.getPath().contains("test"))
            .forEach(Mapping::ignore);
}


// This will ignore any missing test items from the specified world
@SubscribeEvent
void onMissing(final MissingMappingsEvent event) {
    event.getMappings(ForgeRegistries.Keys.ITEMS, MODID).stream()
        .filter(mapping -> mapping.key.path.contains("test"))
            .forEach(Mapping::ignore);
}