Uses of Class
org.bukkit.NamespacedKey
Package
Description
The root package of the Bukkit API, contains generalized API classes.
Classes relevant to attributes.
Classes used to manipulate the voxels in a
world
,
including special states.Classes relevant to banner blocks.
Classes relating to the specialized enhancements to
item stacks
, as part of the meta data
.Interfaces for non-voxel objects that can exist in a
world
, including all players, monsters, projectiles, etc.Classes concerning an entity's persistent memory.
Classes to facilitate world
Structure
generation.Classes involved in manipulating player inventories and item interactions.
The interfaces used when manipulating extra data can can be stored inside
item stacks
.Classes that allow attaching custom data to items.
Armor trim meta types.
Classes relevant to loot table manipulation and generation.
Classes to facilitate plugin handling of
map
displays.Classes dedicated to handling data pack information.
Classes that allow attaching persistent data to various objects.
Classes to represent various
potion
properties and manipulation.Classes related to creating or using
structures
without creating Structure
blocks
in the world.-
Uses of NamespacedKey in com.destroystokyo.paper
ModifierConstructorDescriptionMaterialSetTag
(@Nullable NamespacedKey key, @NotNull Collection<Material> materials) MaterialSetTag
(@Nullable NamespacedKey key, @NotNull Collection<Material> materials, @NotNull Predicate<Material>... globalPredicates) MaterialSetTag
(@Nullable NamespacedKey key, @NotNull Predicate<Material> filter) MaterialSetTag
(@Nullable NamespacedKey key, @NotNull Material... materials) -
Uses of NamespacedKey in com.destroystokyo.paper.entity.ai
-
Uses of NamespacedKey in com.destroystokyo.paper.event.player
Modifier and TypeMethodDescriptionPlayerRecipeBookClickEvent.getRecipe()
Gets the namespaced key of the recipe that was clicked by the playerModifier and TypeMethodDescriptionvoid
PlayerRecipeBookClickEvent.setRecipe
(@NotNull NamespacedKey recipe) Changes what recipe is requested.ModifierConstructorDescriptionPlayerRecipeBookClickEvent
(@NotNull Player player, @NotNull NamespacedKey recipe, boolean makeAll) -
Uses of NamespacedKey in io.papermc.paper.advancement
Modifier and TypeMethodDescriptionAdvancementDisplay.backgroundPath()
Gets the texture displayed behind the advancement tree when selected. -
Uses of NamespacedKey in io.papermc.paper.command.brigadier.argument
Modifier and TypeMethodDescriptionstatic @NotNull com.mojang.brigadier.arguments.ArgumentType
<NamespacedKey> ArgumentTypes.namespacedKey()
A namespaced key argument. -
Uses of NamespacedKey in io.papermc.paper.potion
ModifierConstructorDescriptionPotionMix
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, @NotNull RecipeChoice ingredient) Creates a new potion mix. -
Uses of NamespacedKey in io.papermc.paper.registry
-
Uses of NamespacedKey in io.papermc.paper.tag
ModifierConstructorDescriptionBaseTag
(@NotNull Class<T> clazz, @NotNull NamespacedKey key, @NotNull Collection<T> values) BaseTag
(@NotNull Class<T> clazz, @NotNull NamespacedKey key, @NotNull Collection<T> values, @NotNull Predicate<T>... globalPredicates) EntitySetTag
(@NotNull NamespacedKey key, @NotNull Collection<EntityType> values) EntitySetTag
(@NotNull NamespacedKey key, @NotNull Collection<EntityType> values, @NotNull Predicate<EntityType>... globalPredicates) EntitySetTag
(@NotNull NamespacedKey key, @NotNull Predicate<EntityType> filter) EntitySetTag
(@NotNull NamespacedKey key, @NotNull EntityType... values) -
Uses of NamespacedKey in io.papermc.paper.world.structure
Modifier and TypeMethodDescriptionConfiguredStructure.getKey()
Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of NamespacedKey in org.bukkit
Modifier and TypeMethodDescriptionstatic @Nullable NamespacedKey
NamespacedKey.fromString
(@NotNull String key) Get a NamespacedKey from the supplied string.static @Nullable NamespacedKey
NamespacedKey.fromString
(@NotNull String string, @Nullable Plugin defaultNamespace) Get a NamespacedKey from the supplied string with a default namespace if a namespace is not defined.UnsafeValues.getBiomeKey
(RegionAccessor accessor, int x, int y, int z) Deprecated.Gets theNamespacedKey
for the biome at the given location.Art.getKey()
Fluid.getKey()
Keyed.getKey()
Return the namespaced identifier for this object.Material.getKey()
abstract @NotNull NamespacedKey
MusicInstrument.getKey()
Deprecated.Particle.getKey()
RegionAccessor.getKey()
Get the world's keydefault @Nullable NamespacedKey
Get the key for this object.Sound.getKey()
Statistic.getKey()
StructureType.getKey()
Deprecated.default @NotNull NamespacedKey
Registry.getKeyOrThrow
(T value) Gets the key for this object or throws if it doesn't exist.WorldCreator.key()
Gets the key for this WorldCreatorstatic @NotNull NamespacedKey
Get a key in the Minecraft namespace.static @NotNull NamespacedKey
NamespacedKey.randomKey()
Deprecated.should never be used by plugins, for internal use only!!Modifier and TypeMethodDescriptionstatic @NotNull KeyedBossBar
Bukkit.createBossBar
(@NotNull NamespacedKey key, @Nullable String title, @NotNull BarColor color, @NotNull BarStyle style, @NotNull BarFlag... flags) Creates a boss bar instance to display to players.Server.createBossBar
(@NotNull NamespacedKey key, @Nullable String title, @NotNull BarColor color, @NotNull BarStyle style, @NotNull BarFlag... flags) Creates a boss bar instance to display to players.Registry.get
(@NotNull NamespacedKey key) Get the object by its key.Registry.SimpleRegistry.get
(@NotNull NamespacedKey key) <B extends Keyed>
BUnsafeValues.get
(Registry<B> registry, NamespacedKey key) Deprecated.static @Nullable Advancement
Bukkit.getAdvancement
(@NotNull NamespacedKey key) Get the advancement specified by this key.Server.getAdvancement
(@NotNull NamespacedKey key) Get the advancement specified by this key.static @Nullable KeyedBossBar
Bukkit.getBossBar
(@NotNull NamespacedKey key) Gets theKeyedBossBar
specified by this key.Server.getBossBar
(@NotNull NamespacedKey key) Gets theKeyedBossBar
specified by this key.GameEvent.getByKey
(@NotNull NamespacedKey namespacedKey) Deprecated.UseRegistry.get(NamespacedKey)
instead.static @Nullable MusicInstrument
MusicInstrument.getByKey
(@NotNull NamespacedKey namespacedKey) Deprecated.UseRegistry.get(NamespacedKey)
instead.UnsafeValues.getDefaultEntityAttributes
(@NotNull NamespacedKey entityKey) Deprecated.Gets the default attributes for the entity represented by the namespaced key.UnsafeValues.getFeatureFlag
(@NotNull NamespacedKey key) Deprecated.UnsafeValues.getInternalPotionData
(NamespacedKey key) Deprecated, for removal: This API element is subject to removal in a future version.Bukkit.getLootTable
(@NotNull NamespacedKey key) Gets the specifiedLootTable
.Server.getLootTable
(@NotNull NamespacedKey key) Gets the specifiedLootTable
.Bukkit.getRecipe
(@NotNull NamespacedKey recipeKey) Get theRecipe
for the given key.Server.getRecipe
(@NotNull NamespacedKey recipeKey) Get theRecipe
for the given key.Gets a tag which has already been defined within the server.Gets a tag which has already been defined within the server.Bukkit.getWorld
(@NotNull NamespacedKey worldKey) Gets the world from the given NamespacedKeyServer.getWorld
(@NotNull NamespacedKey worldKey) Gets the world from the given NamespacedKeyboolean
UnsafeValues.hasDefaultEntityAttributes
(@NotNull NamespacedKey entityKey) Deprecated.Checks if the entity represented by the namespaced key has default attributes.UnsafeValues.loadAdvancement
(NamespacedKey key, String advancement) Deprecated.Load an advancement represented by the specified string into the server.static @NotNull WorldCreator
WorldCreator.ofKey
(@NotNull NamespacedKey worldKey) Creates an empty WorldCreator for the given key.static @NotNull WorldCreator
WorldCreator.ofNameAndKey
(@NotNull String levelName, @NotNull NamespacedKey worldKey) Creates an empty WorldCreator for the given world name and keyboolean
UnsafeValues.removeAdvancement
(NamespacedKey key) Deprecated.Delete an advancement which was loaded and saved byUnsafeValues.loadAdvancement(org.bukkit.NamespacedKey, java.lang.String)
.static boolean
Bukkit.removeBossBar
(@NotNull NamespacedKey key) Removes aKeyedBossBar
specified by this key.boolean
Server.removeBossBar
(@NotNull NamespacedKey key) Removes aKeyedBossBar
specified by this key.static boolean
Bukkit.removeRecipe
(@NotNull NamespacedKey key) Remove a recipe from the server.static boolean
Bukkit.removeRecipe
(@NotNull NamespacedKey key, boolean resendRecipes) Remove a recipe from the server.boolean
Server.removeRecipe
(@NotNull NamespacedKey key) Remove a recipe from the server.boolean
Server.removeRecipe
(@NotNull NamespacedKey key, boolean resendRecipes) Remove a recipe from the server.void
UnsafeValues.setBiomeKey
(RegionAccessor accessor, int x, int y, int z, NamespacedKey biomeKey) Deprecated.Sets the biome at the given location to a biome registered to the givenNamespacedKey
.ModifierConstructorDescriptionWorldCreator
(@NotNull String levelName, @NotNull NamespacedKey worldKey) Creates an empty WorldCreator for the given world name and keyWorldCreator
(@NotNull NamespacedKey worldKey) Creates an empty WorldCreator for the given key. -
Uses of NamespacedKey in org.bukkit.attribute
-
Uses of NamespacedKey in org.bukkit.block
Modifier and TypeMethodDescriptionBiome.getKey()
Skull.getNoteBlockSound()
Gets the sound to play if the skull is placed on a note block.Modifier and TypeMethodDescriptionint
Furnace.getRecipeUsedCount
(NamespacedKey furnaceRecipe) Gets the number of times a recipe has been used since the last player removed items from the result slot.boolean
Furnace.hasRecipeUsedCount
(NamespacedKey furnaceRecipe) Checks if the recipe has a used count present on this furnace.void
Skull.setNoteBlockSound
(@Nullable NamespacedKey noteBlockSound) Sets the sound to play if the skull is placed on a note block. -
Uses of NamespacedKey in org.bukkit.block.banner
-
Uses of NamespacedKey in org.bukkit.enchantments
Modifier and TypeMethodDescriptionstatic @Nullable Enchantment
Enchantment.getByKey
(@Nullable NamespacedKey key) Deprecated.only for backwards compatibility, useRegistry.get(NamespacedKey)
instead -
Uses of NamespacedKey in org.bukkit.entity
Modifier and TypeMethodDescriptionCat.Type.getKey()
EntityType.getKey()
Frog.Variant.getKey()
Villager.Profession.getKey()
Villager.Type.getKey()
Modifier and TypeMethodDescriptionHumanEntity.getDiscoveredRecipes()
Get an immutable set of recipes this entity has discovered.Modifier and TypeMethodDescriptionboolean
HumanEntity.discoverRecipe
(@NotNull NamespacedKey recipe) Discover a recipe for this player such that it has not already been discovered.boolean
HumanEntity.hasDiscoveredRecipe
(@NotNull NamespacedKey recipe) Check whether or not this entity has discovered the specified recipe.@NotNull CompletableFuture
<byte[]> Player.retrieveCookie
(@NotNull NamespacedKey key) Retrieves a cookie from this player.void
Player.storeCookie
(@NotNull NamespacedKey key, @org.jetbrains.annotations.NotNull byte[] value) Stores a cookie in this player's client.boolean
HumanEntity.undiscoverRecipe
(@NotNull NamespacedKey recipe) Undiscover a recipe for this player such that it has already been discovered.Modifier and TypeMethodDescriptionint
HumanEntity.discoverRecipes
(@NotNull Collection<NamespacedKey> recipes) Discover a collection of recipes for this player such that they have not already been discovered.int
HumanEntity.undiscoverRecipes
(@NotNull Collection<NamespacedKey> recipes) Undiscover a collection of recipes for this player such that they have already been discovered. -
Uses of NamespacedKey in org.bukkit.entity.memory
Modifier and TypeMethodDescriptionMemoryKey.getByKey
(@NotNull NamespacedKey namespacedKey) Returns aMemoryKey
by aNamespacedKey
. -
Uses of NamespacedKey in org.bukkit.event.player
Modifier and TypeMethodDescriptionPlayerRecipeDiscoverEvent.getRecipe()
Get the namespaced key of the discovered recipe.ModifierConstructorDescriptionPlayerRecipeDiscoverEvent
(@NotNull Player who, @NotNull NamespacedKey recipe) -
Uses of NamespacedKey in org.bukkit.event.world
Modifier and TypeMethodDescriptionAsyncStructureGenerateEvent.getBlockTransformers()
Gets all block transformers in a unmodifiable map.AsyncStructureGenerateEvent.getEntityTransformers()
Gets all entity transformers in a unmodifiable map.Modifier and TypeMethodDescriptionAsyncStructureGenerateEvent.getBlockTransformer
(@NotNull NamespacedKey key) Gets a block transformer by key.AsyncStructureGenerateEvent.getEntityTransformer
(@NotNull NamespacedKey key) Gets a entity transformer by key.void
AsyncStructureGenerateEvent.removeBlockTransformer
(@NotNull NamespacedKey key) Removes a block transformer.void
AsyncStructureGenerateEvent.removeEntityTransformer
(@NotNull NamespacedKey key) Removes a entity transformer.void
AsyncStructureGenerateEvent.setBlockTransformer
(@NotNull NamespacedKey key, @NotNull BlockTransformer transformer) Sets a block transformer to a key.void
AsyncStructureGenerateEvent.setEntityTransformer
(@NotNull NamespacedKey key, @NotNull EntityTransformer transformer) Sets a entity transformer to a key. -
Uses of NamespacedKey in org.bukkit.generator.structure
Modifier and TypeMethodDescriptionabstract @NotNull NamespacedKey
Structure.getKey()
Deprecated.useRegistry.getKey(Keyed)
andRegistry.STRUCTURE
. -
Uses of NamespacedKey in org.bukkit.inventory
Modifier and TypeMethodDescriptionCookingRecipe.getKey()
CraftingRecipe.getKey()
SmithingRecipe.getKey()
StonecuttingRecipe.getKey()
ModifierConstructorDescriptionBlastingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime) BlastingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime) CampfireRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime) CampfireRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime) CookingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime) Create a cooking recipe to craft the specified ItemStack.CookingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime) Create a cooking recipe to craft the specified ItemStack.protected
CraftingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result) FurnaceRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime) Create a furnace recipe to craft the specified ItemStack.FurnaceRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, int data, float experience, int cookingTime) Deprecated.FurnaceRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime) Create a furnace recipe to craft the specified ItemStack.ShapedRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result) Create a shaped recipe to craft the specified ItemStack.ShapelessRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result) Create a shapeless recipe to craft the specified ItemStack.SmithingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice base, @NotNull RecipeChoice addition) Deprecated.as of Minecraft 1.20, smithing recipes are now separated into two distinct recipe types,SmithingTransformRecipe
andSmithingTrimRecipe
.SmithingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice base, @NotNull RecipeChoice addition, boolean copyDataComponents) Deprecated.SmithingTransformRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition) Create a smithing recipe to produce the specified result ItemStack.SmithingTransformRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition, boolean copyDataComponents) Create a smithing recipe to produce the specified result ItemStack.SmithingTrimRecipe
(@NotNull NamespacedKey key, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition) Create a smithing recipe to produce the specified result ItemStack.SmithingTrimRecipe
(@NotNull NamespacedKey key, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition, boolean copyDataComponents) Create a smithing recipe to produce the specified result ItemStack.SmokingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime) SmokingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime) StonecuttingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source) Create a Stonecutting recipe to craft the specified ItemStack.StonecuttingRecipe
(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input) Create a Stonecutting recipe to craft the specified ItemStack. -
Uses of NamespacedKey in org.bukkit.inventory.meta
Modifier and TypeMethodDescriptionSkullMeta.getNoteBlockSound()
Gets the sound to play if the skull is placed on a note block.Modifier and TypeMethodDescriptionKnowledgeBookMeta.getRecipes()
Gets all the recipes in the book.Modifier and TypeMethodDescriptionvoid
KnowledgeBookMeta.addRecipe
(@NotNull NamespacedKey... recipes) Adds new recipe to the end of the book.void
SkullMeta.setNoteBlockSound
(@Nullable NamespacedKey noteBlockSound) Sets the sound to play if the skull is placed on a note block.Modifier and TypeMethodDescriptionvoid
KnowledgeBookMeta.setRecipes
(@NotNull List<NamespacedKey> recipes) Clears the existing book recipes, and sets the book to use the provided recipes. -
Uses of NamespacedKey in org.bukkit.inventory.meta.tags
Modifier and TypeMethodDescription<T,
Z> Z CustomItemTagContainer.getCustomTag
(@NotNull NamespacedKey key, @NotNull ItemTagType<T, Z> type) Deprecated.Returns the custom tag's value that is stored on the item.<T,
Z> boolean CustomItemTagContainer.hasCustomTag
(@NotNull NamespacedKey key, @NotNull ItemTagType<T, Z> type) Deprecated.Returns if the item meta has a custom tag registered matching the provided parameters.void
CustomItemTagContainer.removeCustomTag
(@NotNull NamespacedKey key) Deprecated.Removes a custom key from the item meta.<T,
Z> void CustomItemTagContainer.setCustomTag
(@NotNull NamespacedKey key, @NotNull ItemTagType<T, Z> type, Z value) Deprecated.Stores a custom value on theItemMeta
. -
Uses of NamespacedKey in org.bukkit.inventory.meta.trim
-
Uses of NamespacedKey in org.bukkit.loot
-
Uses of NamespacedKey in org.bukkit.map
-
Uses of NamespacedKey in org.bukkit.packs
Modifier and TypeMethodDescriptionDataPackManager.getDataPack
(@NotNull NamespacedKey dataPackKey) Deprecated, for removal: This API element is subject to removal in a future version.Gets aDataPack
by its key. -
Uses of NamespacedKey in org.bukkit.persistence
Modifier and TypeMethodDescriptionPersistentDataContainer.getKeys()
Get the set of keys present on thisPersistentDataContainer
instance.Modifier and TypeMethodDescription<P,
C> C PersistentDataContainer.get
(@NotNull NamespacedKey key, @NotNull PersistentDataType<P, C> type) Returns the metadata value that is stored on thePersistentDataHolder
instance.<P,
C> C PersistentDataContainer.getOrDefault
(@NotNull NamespacedKey key, @NotNull PersistentDataType<P, C> type, C defaultValue) Returns the metadata value that is stored on thePersistentDataHolder
instance.boolean
PersistentDataContainer.has
(@NotNull NamespacedKey key) Returns if the persistent metadata provider has metadata registered matching the provided parameters.<P,
C> boolean PersistentDataContainer.has
(@NotNull NamespacedKey key, @NotNull PersistentDataType<P, C> type) Returns if the persistent metadata provider has metadata registered matching the provided parameters.void
PersistentDataContainer.remove
(@NotNull NamespacedKey key) Removes a custom key from thePersistentDataHolder
instance.<P,
C> void PersistentDataContainer.set
(@NotNull NamespacedKey key, @NotNull PersistentDataType<P, C> type, C value) Stores a metadata value on thePersistentDataHolder
instance. -
Uses of NamespacedKey in org.bukkit.potion
Modifier and TypeMethodDescriptionPotionEffectTypeWrapper.getKey()
Deprecated.PotionType.getKey()
Modifier and TypeMethodDescriptionstatic @Nullable PotionEffectType
PotionEffectType.getByKey
(@Nullable NamespacedKey key) Deprecated.only for backwards compatibility, useRegistry.get(NamespacedKey)
instead.void
PotionBrewer.removePotionMix
(NamespacedKey key) Removes a potion mix recipe. -
Uses of NamespacedKey in org.bukkit.structure
Modifier and TypeMethodDescriptionStructureManager.getStructures()
Gets the currently registered structures.Modifier and TypeMethodDescriptionvoid
StructureManager.deleteStructure
(@NotNull NamespacedKey structureKey) Unregisters the specified structure and deletes itsstructure file
from the primary world folder.void
StructureManager.deleteStructure
(@NotNull NamespacedKey structureKey, boolean unregister) Deletes thestructure file
for the specified structure from the primary world folder.StructureManager.getStructure
(@NotNull NamespacedKey structureKey) Gets a registered Structure.StructureManager.getStructureFile
(@NotNull NamespacedKey structureKey) Gets the location where a structure file would exist in the primary world directory based on the NamespacedKey using the format world/generated/{NAMESPACE}/structures/{KEY}.nbt.StructureManager.loadStructure
(@NotNull NamespacedKey structureKey) Loads the structure for the specified key and automatically registers it.StructureManager.loadStructure
(@NotNull NamespacedKey structureKey, boolean register) Loads a structure for the specified key and optionallyregisters
it.StructureManager.registerStructure
(@NotNull NamespacedKey structureKey, @NotNull Structure structure) Registers the given structure.void
StructureManager.saveStructure
(@NotNull NamespacedKey structureKey) Saves the currentlyregistered structure
for the specifiedkey
to the primary world folder as specified by {#getStructureFile(NamespacedKey}.void
StructureManager.saveStructure
(@NotNull NamespacedKey structureKey, @NotNull Structure structure) Saves a structure with a given key to the primary world folder.StructureManager.unregisterStructure
(@NotNull NamespacedKey structureKey) Unregisters a structure.
Registry.getKey(Keyed)
andRegistry.INSTRUMENT
.