Package io.papermc.paper.registry.event

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

Type Parameters:

T - registry entry type

B - registry entry builder type

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

Provider for registry events for a specific registry.

Supported events are:

• RegistryEntryAddEvent (via entryAdd())
• RegistryComposeEvent (via compose())

Method Summary

Modifier and Type	Method	Description
LifecycleEventType.Prioritizable<BootstrapContext,RegistryComposeEvent<T,B>>	compose()	Gets the event type for RegistryComposeEvent which is fired after a registry is loaded of expected elements.
RegistryEntryAddEventType<T,B>	entryAdd()	Gets the event type for RegistryEntryAddEvent which is fired just before an object is added to a registry.
default LifecycleEventType.Prioritizable<BootstrapContext,RegistryFreezeEvent<T,B>>	freeze()	Deprecated, for removal: This API element is subject to removal in a future version. use compose() instead.
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

@ScheduledForRemoval(inVersion="1.21.7 or 1.22, whichever comes first")
@Deprecated(since="1.21.6",
            forRemoval=true)
default LifecycleEventType.Prioritizable<BootstrapContext,RegistryFreezeEvent<T,B>> freeze()

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

use compose() instead.

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

compose

LifecycleEventType.Prioritizable<BootstrapContext,RegistryComposeEvent<T,B>> compose()

Gets the event type for RegistryComposeEvent which is fired after a registry is loaded of expected elements. It allows for the registration of new objects.

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

Returns:

the registry freeze event type

registryKey

RegistryKey<T> registryKey()

Gets the registry key associated with this event type provider.

Returns:

the registry key