org.spongepowered.api.event.game

Interface GameRegistryEvent.Register<T extends CatalogType>

Type Parameters:

T - The type of the catalog type

All Superinterfaces:

Event, GameRegistryEvent, GenericEvent<T>

All Known Implementing Classes:

AbstractGameRegistryRegisterEvent

Enclosing interface:

GameRegistryEvent

public static interface GameRegistryEvent.Register<T extends CatalogType>
extends GameRegistryEvent, GenericEvent<T>

This event is called to allow additional registrations for specific CatalogTypes.

When creating custom CatalogRegistryModules, implementing the AdditionalCatalogRegistryModule allows this event to be called for the target CatalogType. All the CatalogTypes will be registered through the AdditionalCatalogRegistryModule.registerAdditionalCatalog(CatalogType) method.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.game.GameRegistryEvent

GameRegistryEvent.Register<T extends CatalogType>

Method Summary

Modifier and Type	Method and Description
Class<T>	getCatalogType() Gets the CatalogType that is allowing registrations.
CatalogRegistryModule<T>	getRegistryModule() Gets the registry module.
void	register(T catalogType) Registers the CatalogType.

Methods inherited from interface org.spongepowered.api.event.GenericEvent

getGenericType

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getCatalogType

Class<T> getCatalogType()

Gets the CatalogType that is allowing registrations.

Returns:

The catalog type

getRegistryModule

CatalogRegistryModule<T> getRegistryModule()

Gets the registry module.

Returns:

The registry module

register

void register(T catalogType)

Registers the CatalogType.

Parameters:

catalogType - The catalog type

Throws:

IllegalArgumentException - If there is an id conflict with the given type and an existing type

UnsupportedOperationException - If registration for the given type is not supported

CatalogTypeAlreadyRegisteredException - If the type cannot be registered because a matching type was already registered