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	Server art.
static final Registry<Attribute>	ATTRIBUTE	Attribute.
static final Registry<Biome>	BIOME	Server biomes.
static final Registry<KeyedBossBar>	BOSS_BARS	Custom boss bars.
static final Registry<ConfiguredStructure>	CONFIGURED_STRUCTURE	Deprecated, for removal: This API element is subject to removal in a future version. use STRUCTURE
static final Registry<Enchantment>	ENCHANTMENT	Server enchantments.
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	Server instruments.
static final Registry<LootTables>	LOOT_TABLES	Default server loot tables.
static final Registry<Material>	MATERIAL	Server materials.
static final Registry<MemoryKey>	MEMORY_MODULE_TYPE	Memory Keys.
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	Server structures.
static final Registry<StructureType>	STRUCTURE_TYPE	Server structure types.
static final Registry<TrimMaterial>	TRIM_MATERIAL	Trim materials.
static final Registry<TrimPattern>	TRIM_PATTERN	Trim patterns.
static final Registry<Villager.Profession>	VILLAGER_PROFESSION	Villager profession.
static final Registry<Villager.Type>	VILLAGER_TYPE	Villager type.

Method Summary

Modifier and Type	Method	Description
T	get(@NotNull NamespacedKey key)	Get the object by its 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

static final Registry<Art> ART

Server art.

See Also:

• Art

ATTRIBUTE

static final Registry<Attribute> ATTRIBUTE

Attribute.

See Also:

• Attribute

BIOME

static final Registry<Biome> BIOME

Server biomes.

See Also:

• Biome

BOSS_BARS

static final Registry<KeyedBossBar> BOSS_BARS

Custom boss bars.

See Also:

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

ENCHANTMENT

static final Registry<Enchantment> ENCHANTMENT

Server enchantments.

See Also:

• Enchantment.getByKey(org.bukkit.NamespacedKey)

ENTITY_TYPE

static final Registry<EntityType> ENTITY_TYPE

Server entity types.

See Also:

• EntityType

INSTRUMENT

static final Registry<MusicInstrument> INSTRUMENT

Server instruments.

See Also:

• MusicInstrument

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

STATISTIC

static final Registry<Statistic> STATISTIC

Server statistics.

See Also:

• Statistic

STRUCTURE

static final Registry<Structure> 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

static final Registry<TrimMaterial> TRIM_MATERIAL

Trim materials.

See Also:

• TrimMaterial

TRIM_PATTERN

static final Registry<TrimPattern> TRIM_PATTERN

Trim patterns.

See Also:

• TrimPattern

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

GAME_EVENT

static final Registry<GameEvent> GAME_EVENT

Game events.

See Also:

• GameEvent

CONFIGURED_STRUCTURE

@Deprecated(forRemoval=true)
static final Registry<ConfiguredStructure> CONFIGURED_STRUCTURE

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

use STRUCTURE

Configured structures.

See Also:

• ConfiguredStructure

POTION_EFFECT_TYPE

static final Registry<PotionEffectType> POTION_EFFECT_TYPE

Potion effect types.

See Also:

• PotionEffectType

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

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