RegistryEventProvider (paper-api 1.21-R0.1-SNAPSHOT API)

Type Parameters:: T - registry entry type; B - registry entry builder type

@Experimental @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

@NonNull RegistryEntryAddEventType<T,B>

entryAdd()

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

@NonNull LifecycleEventType.Prioritizable<BootstrapContext,RegistryFreezeEvent<T,B>>

freeze()

Gets the event type for RegistryFreezeEvent which is fired just before a registry is frozen.

@NonNull RegistryKey<T>

registryKey()

Gets the registry key associated with this event type provider.

Method Details
- entryAdd
  
  @NonNull 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
  
  @NonNull 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
  
  @NonNull RegistryKey<T> registryKey()
  
  Gets the registry key associated with this event type provider.
  
  Returns:
  
  the registry key