Package io.papermc.paper.registry

Interface RegistryKey<T>

Type Parameters:

T - the value type

All Superinterfaces:

Keyed

@NullMarked
public sealed interface RegistryKey<T>
extends Keyed

Identifier for a specific registry. For use with TypedKey and the registry modification API.

There are 2 types of registries, identified as "built-in" or "data-driven". The former are not changeable by datapacks (which doesn't necessarily mean they aren't changeable in the API) and are loaded first. "Data-driven" registries are all created by reading in data from the vanilla and other datapacks.

Field Summary

Fields

Modifier and Type	Field	Description
static final RegistryKey<Attribute>	ATTRIBUTE	Built-in registry for attributes.
static final RegistryKey<PatternType>	BANNER_PATTERN	Data-driven registry for banner patterns.
static final RegistryKey<Biome>	BIOME	Data-driven registry for biomes.
static final RegistryKey<BlockType>	BLOCK	Built-in registry for block types.
static final RegistryKey<Cat.Type>	CAT_VARIANT	Data-driven registry for cat variants.
static final RegistryKey<Chicken.Variant>	CHICKEN_VARIANT	Data-driven registry for chicken variants.
static final RegistryKey<Cow.Variant>	COW_VARIANT	Data-driven registry for cow variants.
static final RegistryKey<DamageType>	DAMAGE_TYPE	Data-driven registry for damage types.
static final RegistryKey<DataComponentType>	DATA_COMPONENT_TYPE	Built-in registry for data component types.
static final RegistryKey<Dialog>	DIALOG	Data-driven registry for dialogs.
static final RegistryKey<Enchantment>	ENCHANTMENT	Data-driven registry for enchantments.
static final RegistryKey<EntityType>	ENTITY_TYPE
static final RegistryKey<Fluid>	FLUID	Built-in registry for fluids.
static final RegistryKey<Frog.Variant>	FROG_VARIANT	Data-driven registry for frog variants.
static final RegistryKey<GameEvent>	GAME_EVENT	Built-in registry for game events
static final RegistryKey<MusicInstrument>	INSTRUMENT	Data-driven registry for instruments.
static final RegistryKey<ItemType>	ITEM	Built-in registry for item types.
static final RegistryKey<JukeboxSong>	JUKEBOX_SONG	Data-driven registry for jukebox songs.
static final RegistryKey<MapCursor.Type>	MAP_DECORATION_TYPE	Built-in registry for map decoration types.
static final RegistryKey<MemoryKey<?>>	MEMORY_MODULE_TYPE
static final RegistryKey<MenuType>	MENU	Built-in registry for menu types.
static final RegistryKey<PotionEffectType>	MOB_EFFECT	Built-in registry for potion effect types (mob effects).
static final RegistryKey<Art>	PAINTING_VARIANT	Data-driven registry for painting variants.
static final RegistryKey<Particle>	PARTICLE_TYPE
static final RegistryKey<Pig.Variant>	PIG_VARIANT	Data-driven registry for pig variants.
static final RegistryKey<PotionType>	POTION
static final RegistryKey<Sound>	SOUND_EVENT	Built-in registry for sound events.
static final RegistryKey<Structure>	STRUCTURE	Data-driven registry for structures.
static final RegistryKey<StructureType>	STRUCTURE_TYPE	Built-in registry for structure types.
static final RegistryKey<TrimMaterial>	TRIM_MATERIAL	Data-driven registry for trim materials.
static final RegistryKey<TrimPattern>	TRIM_PATTERN	Data-driven registry for trim patterns.
static final RegistryKey<Villager.Profession>	VILLAGER_PROFESSION	Built-in registry for villager professions.
static final RegistryKey<Villager.Type>	VILLAGER_TYPE	Built-in registry for villager types.
static final RegistryKey<Wolf.SoundVariant>	WOLF_SOUND_VARIANT	Data-driven registry for wolf sound variants.
static final RegistryKey<Wolf.Variant>	WOLF_VARIANT	Data-driven registry for wolf variants.

Method Summary

Modifier and Type	Method	Description
default TagKey<T>	tagKey(String key)	Constructs a new TagKey for this registry given the tag key's key.
default TagKey<T>	tagKey(Key key)	Constructs a new TagKey for this registry given the tag key's key.
default TypedKey<T>	typedKey(String key)	Constructs a new TypedKey for this registry given the typed key's key.
default TypedKey<T>	typedKey(Key key)	Constructs a new TypedKey for this registry given the typed key's key.

Methods inherited from interface net.kyori.adventure.key.Keyed

key

Field Details

GAME_EVENT

static final RegistryKey<GameEvent> GAME_EVENT

Built-in registry for game events

See Also:

• GameEventKeys

STRUCTURE_TYPE

static final RegistryKey<StructureType> STRUCTURE_TYPE

Built-in registry for structure types.

See Also:

• StructureTypeKeys

MOB_EFFECT

static final RegistryKey<PotionEffectType> MOB_EFFECT

Built-in registry for potion effect types (mob effects).

See Also:

• MobEffectKeys

BLOCK

static final RegistryKey<BlockType> BLOCK

Built-in registry for block types.

See Also:

• BlockTypeKeys

ITEM

static final RegistryKey<ItemType> ITEM

Built-in registry for item types.

See Also:

• ItemTypeKeys

VILLAGER_PROFESSION

static final RegistryKey<Villager.Profession> VILLAGER_PROFESSION

Built-in registry for villager professions.

See Also:

• VillagerProfessionKeys

VILLAGER_TYPE

static final RegistryKey<Villager.Type> VILLAGER_TYPE

Built-in registry for villager types.

See Also:

• VillagerTypeKeys

MAP_DECORATION_TYPE

static final RegistryKey<MapCursor.Type> MAP_DECORATION_TYPE

Built-in registry for map decoration types.

See Also:

• MapDecorationTypeKeys

MENU

static final RegistryKey<MenuType> MENU

Built-in registry for menu types.

See Also:

• MenuTypeKeys

ATTRIBUTE

static final RegistryKey<Attribute> ATTRIBUTE

Built-in registry for attributes.

See Also:

• AttributeKeys

FLUID

static final RegistryKey<Fluid> FLUID

Built-in registry for fluids.

See Also:

• FluidKeys

SOUND_EVENT

static final RegistryKey<Sound> SOUND_EVENT

Built-in registry for sound events.

See Also:

• SoundEventKeys

DATA_COMPONENT_TYPE

static final RegistryKey<DataComponentType> DATA_COMPONENT_TYPE

Built-in registry for data component types.

See Also:

• DataComponentTypeKeys

BIOME

static final RegistryKey<Biome> BIOME

Data-driven registry for biomes.

See Also:

• BiomeKeys

STRUCTURE

static final RegistryKey<Structure> STRUCTURE

Data-driven registry for structures.

See Also:

• StructureKeys

TRIM_MATERIAL

static final RegistryKey<TrimMaterial> TRIM_MATERIAL

Data-driven registry for trim materials.

See Also:

• TrimMaterialKeys

TRIM_PATTERN

static final RegistryKey<TrimPattern> TRIM_PATTERN

Data-driven registry for trim patterns.

See Also:

• TrimPatternKeys

DAMAGE_TYPE

static final RegistryKey<DamageType> DAMAGE_TYPE

Data-driven registry for damage types.

See Also:

• DamageTypeKeys

WOLF_VARIANT

static final RegistryKey<Wolf.Variant> WOLF_VARIANT

Data-driven registry for wolf variants.

See Also:

• WolfVariantKeys

WOLF_SOUND_VARIANT

static final RegistryKey<Wolf.SoundVariant> WOLF_SOUND_VARIANT

Data-driven registry for wolf sound variants.

See Also:

• WolfSoundVariantKeys

ENCHANTMENT

static final RegistryKey<Enchantment> ENCHANTMENT

Data-driven registry for enchantments.

See Also:

• EnchantmentKeys

JUKEBOX_SONG

static final RegistryKey<JukeboxSong> JUKEBOX_SONG

Data-driven registry for jukebox songs.

See Also:

• JukeboxSongKeys

BANNER_PATTERN

static final RegistryKey<PatternType> BANNER_PATTERN

Data-driven registry for banner patterns.

See Also:

• BannerPatternKeys

PAINTING_VARIANT

static final RegistryKey<Art> PAINTING_VARIANT

Data-driven registry for painting variants.

See Also:

• PaintingVariantKeys

INSTRUMENT

static final RegistryKey<MusicInstrument> INSTRUMENT

Data-driven registry for instruments.

See Also:

• InstrumentKeys

CAT_VARIANT

static final RegistryKey<Cat.Type> CAT_VARIANT

Data-driven registry for cat variants.

See Also:

• CatVariantKeys

FROG_VARIANT

static final RegistryKey<Frog.Variant> FROG_VARIANT

Data-driven registry for frog variants.

See Also:

• FrogVariantKeys

CHICKEN_VARIANT

static final RegistryKey<Chicken.Variant> CHICKEN_VARIANT

Data-driven registry for chicken variants.

See Also:

• ChickenVariantKeys

COW_VARIANT

static final RegistryKey<Cow.Variant> COW_VARIANT

Data-driven registry for cow variants.

See Also:

• CowVariantKeys

PIG_VARIANT

static final RegistryKey<Pig.Variant> PIG_VARIANT

Data-driven registry for pig variants.

See Also:

• PigVariantKeys

DIALOG

static final RegistryKey<Dialog> DIALOG

Data-driven registry for dialogs.

See Also:

• DialogKeys

ENTITY_TYPE

static final RegistryKey<EntityType> ENTITY_TYPE

PARTICLE_TYPE

static final RegistryKey<Particle> PARTICLE_TYPE

POTION

static final RegistryKey<PotionType> POTION

MEMORY_MODULE_TYPE

static final RegistryKey<MemoryKey<?>> MEMORY_MODULE_TYPE

Method Details

typedKey

default TypedKey<T> typedKey(Key key)

Constructs a new TypedKey for this registry given the typed key's key.

Parameters:

key - the key of the typed key.

Returns:

the constructed typed key.

typedKey

default TypedKey<T> typedKey(@KeyPattern
 String key)

Constructs a new TypedKey for this registry given the typed key's key.

Parameters:

key - the string representation of the key that will be passed to Key.key(String).

Returns:

the constructed typed key.

tagKey

default TagKey<T> tagKey(Key key)

Constructs a new TagKey for this registry given the tag key's key.

Parameters:

key - the key of the typed key.

Returns:

the constructed tag key.

tagKey

default TagKey<T> tagKey(@KeyPattern
 String key)

Constructs a new TagKey for this registry given the tag key's key.

Parameters:

key - the string representation of the key that will be passed to Key.key(String).

Returns:

the constructed tag key.