Interface RegistrationContext

@NonExtendable
public interface RegistrationContext

Handed to an addon's registration callback. Everything registered through it is owned by addon(). Only valid while the callback runs; static registries freeze afterwards.

Method Summary

Modifier and Type	Method	Description
@NotNull AddonId	addon()
default @NotNull WritableRegistry<BehaviorType>	behaviorTypes()
default @NotNull WritableRegistry<CapabilityType<?>>	capabilityTypes()
default @NotNull WritableRegistry<ResourceComponentType<?>>	componentTypes()
default @NotNull WritableRegistry<ResourceConverter>	converters()
<T extends net.kyori.adventure.key.Keyed> void	createRegistry(@NotNull RegistryType<T> type)	Creates a new registry owned by this addon (static or reloadable, per type).
@NotNull EventBus	events()	The engine's event bus, already usable during registration (e.g.
default void	itemTags(@NotNull ReloadableProvider<ItemTagContribution> provider)
default @NotNull WritableRegistry<MachineType>	machineTypes()
default @NotNull WritableRegistry<ModifierType>	modifierTypes()
default @NotNull WritableRegistry<MultiblockType>	multiblockTypes()
default @NotNull WritableRegistry<NetworkType>	networkTypes()
default @NotNull WritableRegistry<PlayerDataKey<?>>	playerData()	Values kept per player (D37).
default @NotNull WritableRegistry<PlayerSetting<?>>	playerSettings()	Per-player values players change themselves (D37).
default @NotNull WritableRegistry<PlayerDataStorage.Type>	playerStorages()	Places player data can be saved, for players.storage (D37).
default void	recipes(@NotNull ReloadableProvider<Recipe> provider)
default @NotNull WritableRegistry<RecipeType<?>>	recipeTypes()
@NotNull RegistryAccess	registries()	Read access to everything registered so far, including the content of addons this addon depends on (their callbacks already ran).
<T extends net.kyori.adventure.key.Keyed> @NotNull WritableRegistry<T>	registry(@NotNull RegistryType<T> type)
<T extends net.kyori.adventure.key.Keyed> void	reloadable(@NotNull RegistryType<T> type, @NotNull ReloadableProvider<T> provider)	Contributes entries to a reloadable registry; provider runs on every (re)load.
void	report(@NotNull Diagnostic diagnostic)	Adds a finding to the startup report without failing the registration, e.g.
default @NotNull WritableRegistry<ResourceCategory>	resourceCategories()
default void	resourceTags(@NotNull ReloadableProvider<ResourceTagContribution> provider)
default @NotNull WritableRegistry<ResourceType>	resourceTypes()
default @NotNull WritableRegistry<TransportType>	transportTypes()
default @NotNull WritableRegistry<UpgradeType>	upgradeTypes()
void	validator(@NotNull Validator validator)	Adds a validator that runs at startup validation and on every reload.

Method Details

addon

@NotNull
@NotNull AddonId addon()

registries

@NotNull
@NotNull RegistryAccess registries()

Read access to everything registered so far, including the content of addons this addon depends on (their callbacks already ran).

events

@NotNull
@NotNull EventBus events()

The engine's event bus, already usable during registration (e.g. for EngineEvents.REGISTRIES_FROZEN). Subscribe with addon() as owner.

registry

@NotNull
<T extends net.kyori.adventure.key.Keyed>
@NotNull WritableRegistry<T> registry(@NotNull
 @NotNull RegistryType<T> type)

Throws:

RegistrationException - if type does not exist or is not a static registry

createRegistry

<T extends net.kyori.adventure.key.Keyed> void createRegistry(@NotNull
 @NotNull RegistryType<T> type)

Creates a new registry owned by this addon (static or reloadable, per type).

Throws:

RegistrationException - if it already exists

reloadable

<T extends net.kyori.adventure.key.Keyed> void reloadable(@NotNull
 @NotNull RegistryType<T> type,
 @NotNull
 @NotNull ReloadableProvider<T> provider)

Contributes entries to a reloadable registry; provider runs on every (re)load.

validator

void validator(@NotNull
 @NotNull Validator validator)

Adds a validator that runs at startup validation and on every reload.

report

void report(@NotNull
 @NotNull Diagnostic diagnostic)

Adds a finding to the startup report without failing the registration, e.g. a data-driven entry that was skipped. Attributed to addon() if it has no source.

resourceCategories

@NotNull
default @NotNull WritableRegistry<ResourceCategory> resourceCategories()

resourceTypes

@NotNull
default @NotNull WritableRegistry<ResourceType> resourceTypes()

componentTypes

@NotNull
default @NotNull WritableRegistry<ResourceComponentType<?>> componentTypes()

converters

@NotNull
default @NotNull WritableRegistry<ResourceConverter> converters()

resourceTags

default void resourceTags(@NotNull
 @NotNull ReloadableProvider<ResourceTagContribution> provider)

capabilityTypes

@NotNull
default @NotNull WritableRegistry<CapabilityType<?>> capabilityTypes()

machineTypes

@NotNull
default @NotNull WritableRegistry<MachineType> machineTypes()

recipeTypes

@NotNull
default @NotNull WritableRegistry<RecipeType<?>> recipeTypes()

modifierTypes

@NotNull
default @NotNull WritableRegistry<ModifierType> modifierTypes()

upgradeTypes

@NotNull
default @NotNull WritableRegistry<UpgradeType> upgradeTypes()

networkTypes

@NotNull
default @NotNull WritableRegistry<NetworkType> networkTypes()

transportTypes

@NotNull
default @NotNull WritableRegistry<TransportType> transportTypes()

multiblockTypes

@NotNull
default @NotNull WritableRegistry<MultiblockType> multiblockTypes()

behaviorTypes

@NotNull
default @NotNull WritableRegistry<BehaviorType> behaviorTypes()

playerData

@NotNull
default @NotNull WritableRegistry<PlayerDataKey<?>> playerData()

Values kept per player (D37).

playerSettings

@NotNull
default @NotNull WritableRegistry<PlayerSetting<?>> playerSettings()

Per-player values players change themselves (D37).

playerStorages

@NotNull
default @NotNull WritableRegistry<PlayerDataStorage.Type> playerStorages()

Places player data can be saved, for players.storage (D37).

recipes

default void recipes(@NotNull
 @NotNull ReloadableProvider<Recipe> provider)

itemTags

default void itemTags(@NotNull
 @NotNull ReloadableProvider<ItemTagContribution> provider)