Package io.papermc.paper.registry.event

Interface RegistryEventProvider<T,B extends RegistryBuilder<T>>

Type Parameters:

T - registry entry type

B - registry entry builder type

@Experimental
@NullMarked
@NonExtendable
public interface RegistryEventProvider<T,B extends RegistryBuilder<T>>

Provider for registry events for a specific registry.

Supported events are:

• RegistryEntryAddEvent (via entryAdd())
• RegistryFreezeEvent (via freeze())

Method Summary

Modifier and Type	Method	Description
RegistryEntryAddEventType<T,B>	entryAdd()	Gets the event type for RegistryEntryAddEvent which is fired just before an object is added to a registry.
LifecycleEventType.Prioritizable<BootstrapContext,RegistryFreezeEvent<T,B>>	freeze()	Gets the event type for RegistryFreezeEvent which is fired just before a registry is frozen.
RegistryKey<T>	registryKey()	Gets the registry key associated with this event type provider.

Method Details

entryAdd

RegistryEntryAddEventType<T,B> entryAdd()

Gets the event type for RegistryEntryAddEvent which is fired just before an object is added to a registry.

Can be used in LifecycleEventManager.registerEventHandler(LifecycleEventType, LifecycleEventHandler) to register a handler for RegistryEntryAddEvent.

Returns:

the registry entry add event type

freeze

LifecycleEventType.Prioritizable<BootstrapContext,RegistryFreezeEvent<T,B>> freeze()

Gets the event type for RegistryFreezeEvent which is fired just before a registry is frozen. It allows for the registration of new objects.

Can be used in LifecycleEventManager.registerEventHandler(LifecycleEventType, LifecycleEventHandler) to register a handler for RegistryFreezeEvent.

Returns:

the registry freeze event type

registryKey

RegistryKey<T> registryKey()

Gets the registry key associated with this event type provider.

Returns:

the registry key