Package org.bukkit

Interface Registry<T extends Keyed>

Type Parameters:

T - type of item in the registry

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

Registry.SimpleRegistry

public interface Registry<T extends Keyed>
extends Iterable<T>

Represents a registry of Bukkit objects that may be retrieved by NamespacedKey.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Registry.SimpleRegistry<T extends Enum<T> & Keyed>

Field Summary

Fields

Modifier and Type	Field	Description
static final Registry<Advancement>	ADVANCEMENT	Server advancements.
static final Registry<Art>	ART	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.PAINTING_VARIANT
static final Registry<Attribute>	ATTRIBUTE	Attribute.
static final Registry<PatternType>	BANNER_PATTERN	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.BANNER_PATTERN
static final Registry<Biome>	BIOME	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.BIOME
static final Registry<BlockType>	BLOCK	Server block types.
static final Registry<KeyedBossBar>	BOSS_BARS	Custom boss bars.
static final Registry<Cat.Type>	CAT_VARIANT	Server cat types.
static final Registry<DamageType>	DAMAGE_TYPE	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.DAMAGE_TYPE
static final Registry<DataComponentType>	DATA_COMPONENT_TYPE
static final Registry<PotionEffectType>	EFFECT	Server mob effects.
static final Registry<Enchantment>	ENCHANTMENT	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.ENCHANTMENT
static final Registry<EntityType>	ENTITY_TYPE	Server entity types.
static final Registry<Fluid>	FLUID	Server fluids.
static final Registry<Frog.Variant>	FROG_VARIANT	Frog variants.
static final Registry<GameEvent>	GAME_EVENT	Game events.
static final Registry<MusicInstrument>	INSTRUMENT	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.INSTRUMENT
static final Registry<ItemType>	ITEM	Server item types.
static final Registry<JukeboxSong>	JUKEBOX_SONG	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.JUKEBOX_SONG
static final Registry<LootTables>	LOOT_TABLES	Default server loot tables.
static final Registry<MapCursor.Type>	MAP_DECORATION_TYPE	Map cursor types.
static final Registry<Material>	MATERIAL	Server materials.
static final Registry<MemoryKey>	MEMORY_MODULE_TYPE	Memory Keys.
static final Registry<MenuType>	MENU	Server menus.
static final Registry<Particle>	PARTICLE_TYPE	Server particles.
static final Registry<PotionType>	POTION	Server potions.
static final Registry<PotionEffectType>	POTION_EFFECT_TYPE	Potion effect types.
static final Registry<Sound>	SOUNDS	Sound keys.
static final Registry<Statistic>	STATISTIC	Server statistics.
static final Registry<Structure>	STRUCTURE	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.STRUCTURE
static final Registry<StructureType>	STRUCTURE_TYPE	Server structure types.
static final Registry<TrimMaterial>	TRIM_MATERIAL	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.TRIM_MATERIAL
static final Registry<TrimPattern>	TRIM_PATTERN	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.TRIM_PATTERN
static final Registry<Villager.Profession>	VILLAGER_PROFESSION	Villager profession.
static final Registry<Villager.Type>	VILLAGER_TYPE	Villager type.
static final Registry<Wolf.Variant>	WOLF_VARIANT	Deprecated. use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.WOLF_VARIANT

Method Summary

Modifier and Type	Method	Description
default T	get(@NotNull TypedKey<T> typedKey)	Get the object by its typed key.
default T	get(@NotNull Key key)	Get the object by its key.
T	get(@NotNull NamespacedKey key)	Get the object by its key.
default @Nullable NamespacedKey	getKey(T value)	Get the key for this object.
default @NotNull NamespacedKey	getKeyOrThrow(T value)	Gets the key for this object or throws if it doesn't exist.
default T	getOrThrow(@NotNull TypedKey<T> key)	Gets the object by its key or throws if it doesn't exist.
default T	getOrThrow(@NotNull Key key)	Gets the object by its key or throws if it doesn't exist.
T	getOrThrow(@NotNull NamespacedKey key)	Get the object by its key.
default Tag<T>	getTag(@NotNull TagKey<T> key)	Gets the named registry set (tag) for the given key.
default boolean	hasTag(@NotNull TagKey<T> key)	Checks if this registry has a tag with the given key.
default T	match(@NotNull String input)	Deprecated, for removal: This API element is subject to removal in a future version. this method's behavior is broken and not useful.
@NotNull Stream<T>	stream()	Returns a new stream, which contains all registry items, which are registered to the registry.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Details

ADVANCEMENT

static final Registry<Advancement> ADVANCEMENT

Server advancements.

See Also:

• Bukkit.getAdvancement(org.bukkit.NamespacedKey)
• Bukkit.advancementIterator()

ART

@Deprecated(since="1.21.3")
static final Registry<Art> ART

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.PAINTING_VARIANT

Server art.

See Also:

• Art

ATTRIBUTE

static final Registry<Attribute> ATTRIBUTE

Attribute.

See Also:

• Attribute

BANNER_PATTERN

@Deprecated(since="1.21")
static final Registry<PatternType> BANNER_PATTERN

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.BANNER_PATTERN

Server banner patterns.

See Also:

• PatternType

BIOME

@Deprecated(since="1.21.3")
static final Registry<Biome> BIOME

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.BIOME

Server biomes.

See Also:

• Biome

BLOCK

@Internal
static final Registry<BlockType> BLOCK

Server block types.

See Also:

• BlockType

API Note:

BlockType is not ready for public usage yet

BOSS_BARS

static final Registry<KeyedBossBar> BOSS_BARS

Custom boss bars.

See Also:

• Bukkit.getBossBar(org.bukkit.NamespacedKey)
• Bukkit.getBossBars()

CAT_VARIANT

static final Registry<Cat.Type> CAT_VARIANT

Server cat types.

See Also:

• Cat.Type

ENCHANTMENT

@Deprecated(since="1.21")
static final Registry<Enchantment> ENCHANTMENT

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.ENCHANTMENT

Server enchantments.

See Also:

• Enchantment

ENTITY_TYPE

static final Registry<EntityType> ENTITY_TYPE

Server entity types.

See Also:

• EntityType

INSTRUMENT

@Deprecated(since="1.21.2")
static final Registry<MusicInstrument> INSTRUMENT

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.INSTRUMENT

Server instruments.

See Also:

• MusicInstrument

ITEM

@Internal
static final Registry<ItemType> ITEM

Server item types.

See Also:

• ItemType

API Note:

ItemType is not ready for public usage yet

LOOT_TABLES

static final Registry<LootTables> LOOT_TABLES

Default server loot tables.

See Also:

• LootTables

MATERIAL

static final Registry<Material> MATERIAL

Server materials.

See Also:

• Material

MENU

@Experimental
static final Registry<MenuType> MENU

Server menus.

See Also:

• MenuType

EFFECT

static final Registry<PotionEffectType> EFFECT

Server mob effects.

See Also:

• PotionEffectType

PARTICLE_TYPE

static final Registry<Particle> PARTICLE_TYPE

Server particles.

See Also:

• Particle

POTION

static final Registry<PotionType> POTION

Server potions.

See Also:

• PotionType

STATISTIC

static final Registry<Statistic> STATISTIC

Server statistics.

See Also:

• Statistic

STRUCTURE

@Deprecated(since="1.20.6")
static final Registry<Structure> STRUCTURE

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.STRUCTURE

Server structures.

See Also:

• Structure

STRUCTURE_TYPE

static final Registry<StructureType> STRUCTURE_TYPE

Server structure types.

See Also:

• StructureType

SOUNDS

static final Registry<Sound> SOUNDS

Sound keys.

See Also:

• Sound

TRIM_MATERIAL

@Deprecated(since="1.20.6")
static final Registry<TrimMaterial> TRIM_MATERIAL

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.TRIM_MATERIAL

Trim materials.

See Also:

• TrimMaterial

TRIM_PATTERN

@Deprecated(since="1.20.6")
static final Registry<TrimPattern> TRIM_PATTERN

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.TRIM_PATTERN

Trim patterns.

See Also:

• TrimPattern

DAMAGE_TYPE

@Deprecated(since="1.20.6")
static final Registry<DamageType> DAMAGE_TYPE

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.DAMAGE_TYPE

Damage types.

See Also:

• DamageType

JUKEBOX_SONG

@Experimental
@Deprecated(since="1.21")
static final Registry<JukeboxSong> JUKEBOX_SONG

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.JUKEBOX_SONG

Jukebox songs.

See Also:

• JukeboxSong

VILLAGER_PROFESSION

static final Registry<Villager.Profession> VILLAGER_PROFESSION

Villager profession.

See Also:

• Villager.Profession

VILLAGER_TYPE

static final Registry<Villager.Type> VILLAGER_TYPE

Villager type.

See Also:

• Villager.Type

MEMORY_MODULE_TYPE

static final Registry<MemoryKey> MEMORY_MODULE_TYPE

Memory Keys.

See Also:

• MemoryKey

FLUID

static final Registry<Fluid> FLUID

Server fluids.

See Also:

• Fluid

FROG_VARIANT

static final Registry<Frog.Variant> FROG_VARIANT

Frog variants.

See Also:

• Frog.Variant

WOLF_VARIANT

@Deprecated(since="1.20.6")
static final Registry<Wolf.Variant> WOLF_VARIANT

Deprecated.

use RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) with RegistryKey.WOLF_VARIANT

Wolf variants.

See Also:

• Wolf.Variant

MAP_DECORATION_TYPE

static final Registry<MapCursor.Type> MAP_DECORATION_TYPE

Map cursor types.

See Also:

• MapCursor.Type

GAME_EVENT

static final Registry<GameEvent> GAME_EVENT

Game events.

See Also:

• GameEvent

POTION_EFFECT_TYPE

static final Registry<PotionEffectType> POTION_EFFECT_TYPE

Potion effect types.

See Also:

• PotionEffectType

DATA_COMPONENT_TYPE

static final Registry<DataComponentType> DATA_COMPONENT_TYPE

Method Details

get

@Nullable
T get(@NotNull
 @NotNull NamespacedKey key)

Get the object by its key.

Parameters:

key - non-null key

Returns:

item or null if does not exist

get

@Nullable
default T get(@NotNull Key key)

Get the object by its key.

Parameters:

key - non-null key

Returns:

item or null if it does not exist

get

@Nullable
default T get(@NotNull TypedKey<T> typedKey)

Get the object by its typed key.

Parameters:

typedKey - non-null typed key

Returns:

item or null if it does not exist

getOrThrow

@NotNull
default T getOrThrow(@NotNull Key key)

Gets the object by its key or throws if it doesn't exist.

Parameters:

key - the key to get the object of in this registry

Returns:

the object for the key

Throws:

NoSuchElementException - if the key doesn't point to an object in the registry

getOrThrow

@NotNull
default T getOrThrow(@NotNull TypedKey<T> key)

Gets the object by its key or throws if it doesn't exist.

Parameters:

key - the key to get the object of in this registry

Returns:

the object for the key

Throws:

NoSuchElementException - if the key doesn't point to an object in the registry

getKeyOrThrow

@NotNull
default @NotNull NamespacedKey getKeyOrThrow(@NotNull
 T value)

Gets the key for this object or throws if it doesn't exist.

Some types can exist without being in a registry and such will have no key associated with them. This method throw an exception if it isn't in this registry.

Parameters:

value - the value to get the key of in this registry

Returns:

the key for the value

Throws:

NoSuchElementException - if the value doesn't exist in this registry

See Also:

• getKey(Keyed)

getKey

@Nullable
default @Nullable NamespacedKey getKey(@NotNull
 T value)

Get the key for this object.

Some types can exist without being in a registry and such will have no key associated with them. This method will return null.

Parameters:

value - the value to get the key of in this registry

Returns:

the key for the value or null if not in the registry

See Also:

• getKeyOrThrow(Keyed)

hasTag

@Experimental
default boolean hasTag(@NotNull TagKey<T> key)

Checks if this registry has a tag with the given key.

Parameters:

key - the key to check for

Returns:

true if this registry has a tag with the given key, false otherwise

See Also:

• getTag(io.papermc.paper.registry.tag.TagKey)

getTag

@Experimental
@NotNull
default Tag<T> getTag(@NotNull TagKey<T> key)

Gets the named registry set (tag) for the given key.

Parameters:

key - the key to get the tag for

Returns:

the tag for the key

Throws:

NoSuchElementException - if no tag with the given key is found

UnsupportedOperationException - if this registry doesn't have or support tags

See Also:

• hasTag(io.papermc.paper.registry.tag.TagKey)

getOrThrow

@NotNull
T getOrThrow(@NotNull
 @NotNull NamespacedKey key)

Get the object by its key. If there is no object with the given key, an exception will be thrown.

Parameters:

key - to get the object from

Returns:

object with the given key

Throws:

IllegalArgumentException - if there is no object with the given key

stream

@NotNull
@NotNull Stream<T> stream()

Returns a new stream, which contains all registry items, which are registered to the registry.

Returns:

a stream of all registry items

match

@Nullable
@Deprecated(forRemoval=true)
default T match(@NotNull
 @NotNull String input)

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

this method's behavior is broken and not useful. If you want to get an object based on its vanilla name, or a key, wrap it in a NamespacedKey object and use get(NamespacedKey)

Attempts to match the registered object with the given key.

This will attempt to find a reasonable match based on the provided input and may do so through unspecified means.

Parameters:

input - non-null input

Returns:

registered object or null if does not exist