Package net.neoforged.neoforge.registries

Class RegisterEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.registries.RegisterEvent

All Implemented Interfaces:

net.neoforged.fml.event.IModBusEvent

public class RegisterEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.fml.event.IModBusEvent

Fired for each registry when it is ready to have modded objects registered. This event is fired for all builtin registries from vanilla (see BuiltInRegistries) and mods.

This event is fired on the mod-specific event bus, on both logical sides.

See Also:

• register(ResourceKey, ResourceLocation, Supplier)
• register(ResourceKey, Consumer)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterEvent.RegisterHelper<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final Registry<?>	registry
private final ResourceKey<? extends Registry<?>>	registryKey

Constructor Summary

Constructors

Constructor	Description
RegisterEvent(ResourceKey<? extends Registry<?>> registryKey, Registry<?> registry)

Method Summary

Modifier and Type	Method	Description
Registry<?>	getRegistry()
<T> @Nullable Registry<T>	getRegistry(ResourceKey<? extends Registry<T>> key)
ResourceKey<? extends Registry<?>>	getRegistryKey()
<T> void	register(ResourceKey<? extends Registry<T>> registryKey, Consumer<RegisterEvent.RegisterHelper<T>> consumer)	Calls the provided consumer with a register helper if the provided registry key matches this event's registry key.
<T> void	register(ResourceKey<? extends Registry<T>> registryKey, ResourceLocation name, Supplier<T> valueSupplier)	Registers the value with the given name to the stored registry if the provided registry key matches this event's registry key.

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<?>> registryKey

registry

private final Registry<?> registry

Constructor Details

RegisterEvent

RegisterEvent(ResourceKey<? extends Registry<?>> registryKey,
 Registry<?> registry)

Method Details

register

public <T> void register(ResourceKey<? extends Registry<T>> registryKey,
 ResourceLocation name,
 Supplier<T> valueSupplier)

Registers the value with the given name to the stored registry if the provided registry key matches this event's registry key.

Type Parameters:

T - the type of the registry

Parameters:

registryKey - the key of the registry to register the value to

name - the name of the object to register as its key

valueSupplier - a supplier of the object value

See Also:

• a register variant making registration of multiple objects less redundant

register

public <T> void register(ResourceKey<? extends Registry<T>> registryKey,
 Consumer<RegisterEvent.RegisterHelper<T>> consumer)

Calls the provided consumer with a register helper if the provided registry key matches this event's registry key.

Type Parameters:

T - the type of the registry

Parameters:

registryKey - the key of the registry to register objects to

See Also:

• a register variant targeted towards registering one or two objects

getRegistryKey

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

Returns:

The registry key linked to this event

getRegistry

public Registry<?> getRegistry()

Returns:

The registry linked to this event

getRegistry

@Nullable
public <T> @Nullable Registry<T> getRegistry(ResourceKey<? extends Registry<T>> key)

Parameters:

key - the registry key to compare again getRegistryKey()

Returns:

The registry typed to the given registry key if it matches getRegistryKey(), or null if it does not match.