Deprecated API
Contents
- Terminally Deprecated
- Packages
- Interfaces
- Classes
- Enum Classes
- Exception Classes
- Annotation Interfaces
- Fields
- Methods
- Constructors
- Enum Constants
-
Terminally Deprecated ElementsElementDescriptionTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureuse
SoundGroupuseRayTraceResultFor removal, seeCommandson how to use the new Brigadier API.For removal, seeCommandson how to use the new Brigadier API.no longer used anymore since 1.15.2, the value fallback to the default value of the setting when unknown on the server. In this caseClientOption.ChatVisibility.FULLwill be returned.useRayTraceResultuseTNTPrimeEventNot usedThis event is only called after UUID lookups, properties set here will be ignored. UseFillProfileEventfor setting properties.This event is only called for UUID lookups, properties set here will be ignored.This event is only called for UUID lookups, properties set here will be ignored. UsePreFillProfileEventfor setting properties.This event is only called for UUID lookups, properties set here will be ignored. UsePreFillProfileEventfor setting properties.UsePaperServerListPingEvent.getListedPlayers(), as this does not contain real player profilesthe Iterable interface will be removed at some pointfor removal. SeeMessageComponentSerializerfor a direct replacement of functionality found in this class. As a general entrypoint to brigadier on paper, seeCommands.Removed as it causes a warning to appear on the client now.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.DIALOG. Dialogs can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.DIALOG. Dialogs can exist without a key.Enchantments do not have a "rarity" since 1.20.5relative velocity flags now allow for the whole rotation to be relative, instead of the yaw and pitch having individual options. UseTeleportFlag.Relative.VELOCITY_ROTATIONinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Xinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Yinstead.relative velocity flags now allow for the whole rotation to be relative, instead of the yaw and pitch having individual options. UseTeleportFlag.Relative.VELOCITY_ROTATIONinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Zinstead.useItemRaritywithItemMeta.getRarity()useRegistryEventProvider.compose()instead.renamed toRegistryComposeEventuseRegistryAccess.getRegistry(RegistryKey)with keys fromRegistryKeywill be removed in adventure 5.0.0, usePlainTextComponentSerializer.plainText()Magic value that is based on inconsistent, data-driven registryMagic value that is based on inconsistent, data-driven registryuseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.PAINTING_VARIANT. Painting variants can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.PAINTING_VARIANT. Painting variants can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().useAttributeInstance.getModifier(net.kyori.adventure.key.Key), modifiers are no longer stored by UUIDuseAttributeInstance.removeModifier(net.kyori.adventure.key.Key), modifiers are no longer stored by UUIDattributes are now identified by keysmagic value, useRegistry.get(NamespacedKey)instead withRegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey)andRegistryKey.BANNER_PATTERNmagic valueuseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.BANNER_PATTERN. PatternTypes can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.BANNER_PATTERN. PatternTypes can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().Biome is no longer an enum, custom biomes will have their own biome instance.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().Magic valuepartially replaced byBlock.isPreferredTool(ItemStack)Magic valueMagic valueincorrect name as multiple types of flower collection blocks exist now. UseFlowerBedcheckMaterialinsteadcheckMaterialinsteadhas not functioned for a long time as the spawn radius is defined by the server.properties file. There is no API replacement for this method. It is generally recommended to implement "protection"-like behaviour via events or third-party plugin APIs.chat previews have been removedAll methods on this class have been deprecated, see the individual methods for replacements.Magic valueTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureThe conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.no longer existsno longer existsNo longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existspartially replaced byEffect.BEE_GROWTHUseEnchantment.getActiveSlotGroups()instead as enchantments are now applicable to a group of equipment slots.Enchantments now have a complex effect systems that cannot be reduced to a simple damage increase.Enchantments now have a complex effect systems that cannot be reduced to a simple damage increase.enchantment groupings are now managed by tags, not categoriesenchantments are badly named, useKeyed.getKey().As of 1.20.5 enchantments do not have a rarity.this method assumes that the enchantments description always be a translatable component which is not guaranteed.enchantment groupings are now managed by tags, not categoriesthis target no longer exists in Vanillaonly for backwards compatibility, EnchantmentWrapper is no longer used.moved to being a function of the firing weapon, always returns 0 heremoved to being a function of the firing weapon, does nothing herea function of the firing weapon instead, this method does nothingdifferent variants are different classesuseAbstractHorse.isEatingGrass(), this name is incorrectuseAbstractHorse.setEatingGrass(boolean), this name is incorrectyou are required to spawn a different entityshould check what class instance this is.Must spawn a new subtype variantUpgraded / extended potions are now their ownPotionTypeuseAreaEffectCloud.getBasePotionType()instead.Upgraded / extended potions are now their ownPotionTypeuseAreaEffectCloud.setBasePotionType(org.bukkit.potion.PotionType)instead.Upgraded / extended potions are now their ownPotionTypeuseArrow.getBasePotionType()instead.Upgraded / extended potions are now their ownPotionTypeuseArrow.setBasePotionType(org.bukkit.potion.PotionType)instead.deprecated in favor ofBoat.getBoatType()deprecated in favor ofBoat.setBoatType(Type)only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().this functionality no longer existsthis functionality no longer existsmethod is for internal use only and will be removedMagic valueMagic valuehas no effect in newer Minecraft versionshas no effect in newer Minecraft versionsMinecraft no longer has a distinction for these types of mobs.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().seeChestedHorseseeChestedHorseuseInventoryViewand its children.Unsupported apiUnsupported apisound is now client side and cannot be removedentity groupings are now managed by tags, not categoriesHopper minecarts don't have cooldowns anymoreHopper minecarts don't have cooldowns anymoreuseMushroomCow.addEffectToNextStew(io.papermc.paper.potion.SuspiciousEffectEntry, boolean)as PotionEffect suggests that all attributes are used. In fact, only the PotionEffectType and the duration are used.Mushroom cows can now hold multiple effects, useMushroomCow.getStewEffects()Mushroom cows can now hold multiple effects, useMushroomCow.getStewEffects()Mushroom cows can now hold multiple effects, useMushroomCow.setStewEffects(java.util.List)Mushroom cows can now hold multiple effects, useMushroomCow.setStewEffects(java.util.List)Magic valueMagic valueThis is no longer sent from the client and will always be nulldoes not do anythingdoes not do anythingSpigots shearable API miserably fails at capturing all entities that may be sheared by a player, like mushroom cows which, once sheared, convert into normal cows. For such entities, methods likeShearable.setSheared(boolean)orShearable.isSheared()make no sense, making this API and interface dead API from the get-go.UseShearable.readyToBeSheared()instead.UseShearable.shear()instead if applicable. Some entities cannot be "unsheared".only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().Duplicate api, useWither.getInvulnerableTicks()Duplicate api, useWither.setInvulnerableTicks(int)check if instanceofZombieVillager.must spawnZombieVillager.Since 1.21.2 all zombie types can break doors if instructed as MC-137053 was fixed.split into individual effectsraid system was overhauled in 1.20.5split into individual effectsreplaced by theblocks_attacksitem data componentreplaced by theblocks_attacksitem data componentuseBrewingStartEvent.getBrewingTime()insteaduseBrewingStartEvent.setBrewingTime(int)insteadno longer called, chunks are generated with entities already existing. Consider usingChunkLoadEvent,ChunkLoadEvent.isNewChunk()andChunk.getEntities()for similar effect.duration is now a floatno longer used, player now gets an ominous bottle insteadThis action no longer happens, they are allInventoryAction.HOTBAR_SWAPs.the respawn point is now set when the player enter the bed and this option doesn't work since MC 1.15.the respawn point is now set when the player enter the bed and this option doesn't work since MC 1.15.org.bukkit.event.player.PlayerBucketEmptyEvent(Player, Block, Block, BlockFace, Material, ItemStack) has never been functional since its implementation and simply returns the old main hand. The method is left in this broken state to not break compatibility with plugins that relied on this fact. UsePlayerChangedMainHandEvent.getNewMainHand()instead or migrate toPlayerClientOptionsChangeEvent.getMainHand().This is simply the online players. Modifications have no effectOnly works for sign commands; usePlayer.performCommand(String), including those casesbooks may be signed from off handthe mending enchantment uses enchantment effects to compute how much durability is granted per xp. The enchantment effects operation are too complex to reliably offer the inverse function.the mending enchantment uses enchantment effects to compute how much durability is granted per xp. The enchantment effects operation are too complex to reliably offer the inverse function.No effectNo effectThis is no longer sent from the client and will always be nulldismounting on tp is no longer controlled by the serverthe Iterable interface will be removed at some pointchat previews have been removedonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.STRUCTURE. Structures can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.STRUCTURE. Structures can exist without a key.useBlockDataMagic valueuseInventoryViewand its childrenItemStackimplementsTranslatable; use that andComponent.translatable(net.kyori.adventure.translation.Translatable)instead.this method uses an ambiguous data byte objectcast toBlockDataMetaand useBlockDataMeta.getBlockData(Material)useItemStack.getMaxItemUseDuration(org.bukkit.entity.LivingEntity); crossbows, later possibly more items require an entity parameterno longer available on the component directlyno longer available on the component directlythis API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_BREAKinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_PLACE_ONinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_BREAKinstead of this.UseItemMeta.displayName()and cast it to aTranslatableComponent. No longer used by the client.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_PLACE_ONinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.hasData(DataComponentType)withDataComponentTypes.CAN_BREAKinstead of this.UseItemMeta.displayName()and check if it is instanceof aTranslatableComponent.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.hasData(DataComponentType)withDataComponentTypes.CAN_PLACE_ONinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_BREAKinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_PLACE_ONinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_BREAKinstead of this.UseItemMeta.displayName(Component)with aTranslatableComponent. No longer used by the client.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_PLACE_ONinstead of this.Upgraded / extended potions are now their ownPotionTypeusePotionMeta.getBasePotionType()instead.conflicting name, usePotionMeta.getCustomPotionName()conflicting name, usePotionMeta.hasCustomPotionName()Upgraded / extended potions are now their ownPotionTypeusePotionMeta.setBasePotionType(org.bukkit.potion.PotionType)instead.conflicting name, usePotionMeta.setCustomPotionName(String)different types are different itemsdifferent types are different itemsthis API part has been replaced by thePersistentDataHolderAPI. Please usePersistentDataHolderinstead of this.this API part has been replaced byPersistentDataHolder. Please usePersistentDataAdapterContextinstead of this.please usePersistentDataTypeas this part of the api is being replaceduseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.this method assumes thatTrimMaterial.description()will always be a translatable component which is not guaranteed.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_PATTERN. TrimPatterns can exist without a key.this method assumes thatTrimPattern.description()will always be a translatable component which is not guaranteed.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_PATTERN. TrimPatterns can exist without a key.this method assumes that jukebox song description will always be a translatable component which is not guaranteed.no longer functionalno longer functionalonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().use color directlyuse color-related methodsuse color-related methodsuse color-related methodsall usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.currently does not have an implementation which is well linked to the underlying server. Contributions welcome.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.useSpawnEggMetaall usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.use BlockDataMagic valueMagic valueall usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.INSTRUMENT. MusicInstruments can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.INSTRUMENT. MusicInstruments can exist without a key.this method assumes that the instrument description always be a translatable component which is not guaranteed.Plugin loading now occurs at a point which makes it impossible to expose this behavior. This instance will only throw unsupported operation exceptions.all plugins are now assumed to be UTF-8 aware.unusedusePotionEffectType.createEffect(int, int)instead.Upgraded / extended potions are now their ownPotionTypeusePotionType.getPotionEffects()insteadNon-FunctionalUpgraded / extended potions are now their ownPotionTypeuse them instead.unused, always 1.0useKeyed.key()only for backwards compatibility, PotionEffectTypeWrapper is no longer used.Do not use, interface will get removed, and the plugin won't runRaid identifiers are magic internal values and may or may not be present. -1 is returned for raids without an assigned id.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 aNamespacedKeyobject and useRegistry.get(NamespacedKey)useBlockDatause the constants declared inCriteriainsteadchat previews have been removedAll methods on this class have been deprecated, see the individual methods for replacements.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.UseServer.restart()instead.checkMaterialinsteaduseRegistry.getKey(Keyed)andRegistry.SOUNDS. Sounds can exist without a key.useRegistry.getKey(Keyed)andRegistry.SOUNDS. Sounds can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().partially replaced byTag.DRY_VEGETATION_MAY_PLACE_ONpartially replaced byTag.ITEMS_STONE_CRAFTING_MATERIALSremoved in Minecraft 1.20.5. Do not use. Will be removed at a later date. Until then, this constant now acts as a reference toTag.ITEMS_BREAKS_DECORATED_POTSwhich largely shares the same contents of the old "minecraft:tools" tag.useTranslatablelook for atranslationKey()method insteadDeprecated, see usage methods for replacement(s)custom biomes are properly supported in API nowcustom biomes are properly supported in API nowUseConsumerinsteadonly for backwards compatibility.only for backwards compatibility, old enums can not be compared.only for backwards compatibility.only for backwards compatibility, it is not guaranteed that an old enum always has the same ordinal.unused as of 1.19No longer functional since 1.21.9, the vanilla server does not have the concept of spawn chunks anymore.regenerating a single chunk is not likely to produce the same chunk as before as terrain decoration may be spread across chunks. It may or may not change blocks in the adjacent chunks as well.No longer functional since 1.21.9, the vanilla server does not have the concept of spawn chunks anymore.Magic value. UseRegionAccessor.spawn(Location, Class, Consumer)(or a variation thereof) in combination withFallingBlock.setBlockData(BlockData)UseRegionAccessor.spawn(Location, Class, Consumer)(or a variation thereof) in combination withFallingBlock.setBlockData(BlockData)completely unfunctional as the server no longer has always loaded spawn chunks.completely unfunctional as the server no longer has always loaded spawn chunks.The spawn location is selected during the configuration phase, before a player entity is normally created. Using the result ofPlayerEvent.getPlayer()for anything related to the player entity is unreliable and may cause issues. RetrievingEntity.getUniqueId()andPlayer.getName()is safe. Prefer usingAsyncPlayerSpawnLocationEvent.
-
Deprecated PackagesPackageDescriptionThe conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to the
AsyncChatEventor alternatively usingDialogto get user input.This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0
-
Deprecated InterfacesInterfaceDescriptionTimings will be removed in the futureuse
SoundGroupFor removal, seeCommandson how to use the new Brigadier API.For removal, seeCommandson how to use the new Brigadier API.renamed toRegistryComposeEventincorrect name as multiple types of flower collection blocks exist now. UseFlowerBedTimings will be removed in the futureThe conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.Minecraft no longer has a distinction for these types of mobs.Spigots shearable API miserably fails at capturing all entities that may be sheared by a player, like mushroom cows which, once sheared, convert into normal cows. For such entities, methods likeShearable.setSheared(boolean)orShearable.isSheared()make no sense, making this API and interface dead API from the get-go.tipped status depends only on base potion type not being UNCRAFTABLE and effects being empty.Biomes are now set withBiomeProviderthis API part has been replaced by thePersistentDataHolderAPI. Please usePersistentDataHolderinstead of this.this API part has been replaced byPersistentDataHolder. Please usePersistentDataAdapterContextinstead of this.please usePersistentDataTypeas this part of the api is being replacedThis system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0Do not use, interface will get removed, and the plugin won't runseePlayerProfileuseTranslatableUseConsumerinsteadonly for backwards compatibility.Use either the Future or the Consumer based methods
-
Deprecated ClassesClassDescriptionTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureTimings will be removed in the futureuse
RayTraceResultuseRayTraceResultuseTNTPrimeEventFor removal, use the new brigadier api.Deprecated, useProjectileHitEventand check if there is a hit entityNot useduseTitlefor removal. SeeMessageComponentSerializerfor a direct replacement of functionality found in this class. As a general entrypoint to brigadier on paper, seeCommands.useBellRingEventListening to this event forces chat to wait for the main thread, delaying chat messages. It is recommended to useAsyncChatEventinstead, wherever possible.Timings will be removed in the futureThe conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to theAsyncChatEventor alternatively usingDialogto get user input.only for backwards compatibility, EnchantmentWrapper is no longer used.Unsupported apiuseAsyncChatEventinsteadchat previews have been removedUse the more genericPlayerBucketEntityEventListening to this event forces chat to wait for the main thread, delaying chat messages. It is recommended to useAsyncChatEventinstead, wherever possible.This event is no longer fired due to client changesUsePlayerConnectionValidateLoginEventto handle pre-login logic (e.g. authentication or ban checks), orPlayerServerFullCheckEventto allow players to bypass the server's maximum player limit. Minecraft triggers this twice internally, using this event skips one of the validation checks done by the server. Additionally, this event causes the full player entity to be created much earlier than it would be in Vanilla, leaving it with mostly dysfunctional methods and state.This event causes synchronization from the login thread;AsyncPlayerPreLoginEventis preferred to keep the secondary threads asynchronous.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.useSpawnEggMetaall usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.all usage of MaterialData is deprecated and subject to removal. UseBlockData.This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0Upgraded / extended potions are now their ownPotionTypeuse them instead.only for backwards compatibility, PotionEffectTypeWrapper is no longer used.use the constants declared inCriteriainsteadThis class does not represent the structures of a world well. UseStructureorStructureTypeinstead.Object streams on their own are not safe. For safer and more consistent serialization of items, useItemStack.serializeAsBytes()orItemStack.serializeItemsAsBytes(java.util.Collection).Object streams on their own are not safe. For safer and more consistent serialization of items, useItemStack.serializeAsBytes()orItemStack.serializeItemsAsBytes(java.util.Collection).The spawn location is selected during the configuration phase, before a player entity is normally created. Using the result ofPlayerEvent.getPlayer()for anything related to the player entity is unreliable and may cause issues. RetrievingEntity.getUniqueId()andPlayer.getName()is safe. Prefer usingAsyncPlayerSpawnLocationEvent.
-
Deprecated Enum ClassesEnum ClassDescription
PlayerArmorChangeEvent.SlotTypedoes not accurately represent what item types are valid in each slot.Enchantments do not have a "rarity" since 1.20.5useItemRaritywithItemMeta.getRarity()useBanListTypeto enforce the correct return value at compile time.this property is not specific to the Crafter, useOrientationinstead. All references to this enum will be redirected to that enum at runtime.this property is not specific to the Jigsaw, useOrientationinstead. All references to this enum will be redirected to that enum at runtime.this property is not specific to the MossyCarpet, useWall.Heightinstead. All references to this enum will be redirected to that enum at runtime.ChatColor has been deprecated in favor of Adventure API. SeeNamedTextColorfor the adventure equivalent of pre-defined text colorsnot representative of what Effect doesenchantment groupings are now managed by tags, not categoriesdifferent boats types are now different entity typesfuture versions of Minecraft have additional spell casting entities.different variants are differing classesCats are now a separate entity.classes are different types. This interface only remains in the Skeleton interface to preserve backwards compatibility.This API is responsible for a large number of implementation problems and is in general unsustainable to maintain.useBlockDatauseInventoryViewand its childrenuse BlockDatauseBlockDatareplaced byTeam.OptionStatuscheckMaterialinsteadDeprecated, see usage methods for replacement(s)
-
Deprecated Exception ClassesException ClassDescriptionThis system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you use
PersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0This system is extremely misleading and does not cleanup values for metadatable entities that have been removed. It is recommended that when wanting persistent metadata, you usePersistentDataContainer. If you want temporary values on an entity, just use the entity lifecycle events. (SeeEntityAddToWorldEvent0
-
Deprecated Annotation InterfacesAnnotation InterfaceDescriptionThis should generally not be used in any new API code as it suggests a bad API design.
-
Deprecated FieldsFieldDescriptionin favour of
Tag.ITEMS_ARROWSin favour ofTag.ITEMS_AXESin favour ofTag.BEDSin favour ofTag.ITEMS_FOOT_ARMORany item can be equippable with the right data component set on itin favour ofTag.ITEMS_CHEST_ARMORin favour ofTag.ITEMS_COALSin favour ofTag.CONCRETE_POWDERin favour ofTag.DOORSin favour ofTag.ITEMS_ENCHANTABLE_VANISHINGand other similar enchantable tagsin favour ofTag.FENCE_GATESin favour ofTag.FENCESany item can be equippable with the right data component set on itin favour ofTag.ITEMS_HEAD_ARMORin favour ofTag.ITEMS_HOESin favour ofTag.LANTERNSin favour ofTag.ITEMS_LEG_ARMORin favour ofTag.ITEMS_PICKAXESin favour ofTag.PRESSURE_PLATESin favour ofTag.RAILSin favour ofTag.ITEMS_SHOVELSin favour ofTag.SHULKER_BOXESin favour ofTag.ALL_SIGNSin favour ofTag.ITEMS_SWORDSin favour ofTag.TRAPDOORSin favour ofTag.WOODEN_DOORSin favour ofTag.WOODEN_FENCESin favour ofTag.FENCE_GATESin favour ofTag.WOODEN_TRAPDOORSrelative velocity flags now allow for the whole rotation to be relative, instead of the yaw and pitch having individual options. UseTeleportFlag.Relative.VELOCITY_ROTATIONinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Xinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Yinstead.relative velocity flags now allow for the whole rotation to be relative, instead of the yaw and pitch having individual options. UseTeleportFlag.Relative.VELOCITY_ROTATIONinstead.Since 1.21.3, vanilla split up the relative teleport flags into velocity and position related ones. As the API does not deal with position relative flags, this name is no longer applicable. UseTeleportFlag.Relative.VELOCITY_Zinstead.in favour ofTag.ENTITY_TYPES_UNDEADin favour ofTag.ENTITY_TYPES_AQUATICBiome is no longer an enum, custom biomes will have their own biome instance.Timings will be removed in the futureunused, not intended to be APIunused, not intended to be APIthis constant uses the wrong generic type, the sniffer now stores different positions from possibly different worlds. Use the relevant methods inSnifferdirectly for now.not available since 1.21.2not available since 1.20 Thetrade_rebalancefeature flag.not available since 1.21not available since 1.21.4in favor ofGameEvent.BLOCK_ACTIVATEin favor ofGameEvent.BLOCK_ACTIVATEin favor ofGameEvent.BLOCK_DEACTIVATEin favor ofGameEvent.BLOCK_DEACTIVATEin favor ofGameEvent.BLOCK_ACTIVATEin favor ofGameEvent.DRINKin favor ofGameEvent.ELYTRA_GLIDEin favor ofGameEvent.ENTITY_DAMAGEin favor ofGameEvent.ENTITY_DIEin favor ofGameEvent.ENTITY_DIEin favor ofGameEvent.ENTITY_ACTIONin favor ofGameEvent.ENTITY_ACTIONin favor ofGameEvent.ENTITY_INTERACTin favor ofGameEvent.BLOCK_DEACTIVATEin favor ofGameEvent.BLOCK_ACTIVATEin favor ofGameEvent.ENTITY_ACTIONin favor ofGameEvent.BLOCK_CHANGEin favor ofGameEvent.CONTAINER_CLOSEin favor ofGameEvent.CONTAINER_OPENin favor ofGameEvent.ENTITY_ACTIONMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueUsePersistentDataType.LIST'sListPersistentDataTypeProvider.dataContainers()instead asListPersistentDataTypes offer full support for primitive types, such as thePersistentDataContainer.partially replaced byTag.DRY_VEGETATION_MAY_PLACE_ONpartially replaced byTag.ITEMS_STONE_CRAFTING_MATERIALSremoved in Minecraft 1.20.5. Do not use. Will be removed at a later date. Until then, this constant now acts as a reference toTag.ITEMS_BREAKS_DECORATED_POTSwhich largely shares the same contents of the old "minecraft:tools" tag.
-
Deprecated MethodsMethodDescriptionDoesn't do anything - Removed
PlayerArmorChangeEvent.SlotTypedoes not accurately represent what item types are valid in each slot. UsePlayerArmorChangeEvent.getSlot()instead.This event is only called after UUID lookups, properties set here will be ignored. UseFillProfileEventfor setting properties.This event is only called for UUID lookups, properties set here will be ignored.This event is only called for UUID lookups, properties set here will be ignored. UsePreFillProfileEventfor setting properties.This event is only called for UUID lookups, properties set here will be ignored. UsePreFillProfileEventfor setting properties.UsePaperServerListPingEvent.getListedPlayers(), as this does not contain real player profilesthe Iterable interface will be removed at some pointshould never be used by plugins, for internal use only!!serverVersionis not requireduseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.DIALOG. Dialogs can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.DIALOG. Dialogs can exist without a key.check ifWaterBottleSplashEvent.getToDamage()contains an entityuseWaterBottleSplashEvent.damageAsWaterSensitive(LivingEntity)orWaterBottleSplashEvent.doNotDamageAsWaterSensitive(LivingEntity)to change which entities are damagedin favour ofAbstractRespawnEvent.getRespawnReason()/AbstractRespawnEvent.isBedSpawn/AbstractRespawnEvent.isAnchorSpawn()useRegistryEventProvider.compose()instead.useRegistryAccess.getRegistry(RegistryKey)with keys fromRegistryKeywill be removed in adventure 5.0.0, usePlainTextComponentSerializer.plainText()Magic value that is based on inconsistent, data-driven registryonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.Magic value that is based on inconsistent, data-driven registryuseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.PAINTING_VARIANT. Painting variants can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.PAINTING_VARIANT. Painting variants can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().useAttributeInstance.getModifier(net.kyori.adventure.key.Key), modifiers are no longer stored by UUIDuseAttributeInstance.removeModifier(net.kyori.adventure.key.Key), modifiers are no longer stored by UUIDattributes are now identified by keysThis return a generic class, prefer useBanList.getEntries()magic value, useRegistry.get(NamespacedKey)instead withRegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey)andRegistryKey.BANNER_PATTERNmagic valueuseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.BANNER_PATTERN. PatternTypes can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.BANNER_PATTERN. PatternTypes can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only encodes y block ranges from -512 to 511 and represents an already changed implementation detailMagic valuepartially replaced byBlock.isPreferredTool(ItemStack)Magic valueMagic valueonly for internal useThis method is not comprehensive and does not accurately reflect what block types are interactable. Many "interactions" are defined on the item not block, and many are conditional on some other world state checks being true.in favour ofCommandBlock.name()magic value, useBaseSpawner.getSpawnedType().magic value, useBaseSpawner.setSpawnedType(org.bukkit.entity.EntityType).bad name, useCaveVinesPlant.hasBerries()bad name, useSculkSensor.getSculkSensorPhase()bad name, useSculkSensor.setSculkSensorPhase(Phase)in favor ofDecoratedPot.getSherds()locks are not necessarily pure stringslocks are not necessarily pure stringsA sign may have multiple writable sides now. UseSign.getSide(Side)andColorable.getColor().A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.line(int).A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.lines().useSign.isWaxed()insteadA sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.isGlowingText().A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.line(int).A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.line(int, net.kyori.adventure.text.Component).A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.lines().A sign may have multiple writable sides now. UseSign.getSide(Side)andColorable.setColor(org.bukkit.DyeColor).useSign.setWaxed(boolean)insteadA sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.setGlowingText(boolean).A sign may have multiple writable sides now. UseSign.getSide(Side)andSignSide.line(int, net.kyori.adventure.text.Component).in favour ofSignSide.line(int)in favour ofSignSide.lines()UseSkull.getPlayerProfile()instead.useBlockDatacheckMaterialinsteaduseBlockDatacheckMaterialinsteadin favour ofBukkit.broadcast(Component, String)in favour ofServer.broadcast(Component)in favour ofBukkit.createMerchant(Component). The title parameter is no-longer needed when used withMenuType.MERCHANTandMenuType.Typed.builder()The title parameter is no-longer needed when used withMenuType.MERCHANTandMenuType.Typed.builder().Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)useBukkit.getBanList(io.papermc.paper.ban.BanListType)to enforce the correct return value at compile time.Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)in favour ofBukkit.motd()useRegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey)with keys fromRegistryKeyin favour ofBukkit.shutdownMessage()Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)in favour ofBukkit.motd(Component)has not functioned for a long time as the spawn radius is defined by the server.properties file. There is no API replacement for this method. It is generally recommended to implement "protection"-like behaviour via events or third-party plugin APIs.chat previews have been removedAll methods on this class have been deprecated, see the individual methods for replacements.biomes are now 3-dimensionalMagic valuebiomes are now 3-dimensionalMagic valueMagic valuepermission messages have not worked for player-executed commands since 1.13 as clients without permission to execute a command are unaware of its existence and therefore will not send an unknown command execution to the server. This message will only ever be shown to consoles or when this command is executed withBukkit.dispatchCommand(CommandSender, String).Timings will be removed in the futurepermission messages have not worked for player-executed commands since 1.13 as clients without permission to execute a command are unaware of its existence and therefore will not send an unknown command execution to the server. This message will only ever be shown to consoles or when this command is executed withBukkit.dispatchCommand(CommandSender, String).permission messages have not worked for player-executed commands since 1.13 as clients without permission to execute a command are unaware of its existence and therefore will not send an unknown command execution to the server. This message will only ever be shown to consoles or when this command is executed withBukkit.dispatchCommand(CommandSender, String).permission messages have not worked for player-executed commands since 1.13 as clients without permission to execute a command are unaware of its existence and therefore will not send an unknown command execution to the server. This message will only ever be shown to consoles or when this command is executed withBukkit.dispatchCommand(CommandSender, String).sender UUID is ignoredsender UUID is ignoredusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentThis method only exists for backwards compatibility. It will do nothing and should not be used! Please useFileConfigurationOptions.getHeader()instead.CallFileConfigurationOptions.parseComments()instead.CallFileConfigurationOptions.parseComments(boolean)instead.use getHeader() instead.use setHeader() insteadsender UUID is ignoredMagic valueMagic valueMagic valueMagic valuesome effects can be both or neitherUseEnchantment.getActiveSlotGroups()instead as enchantments are now applicable to a group of equipment slots.only for backwards compatibility, useRegistry.get(NamespacedKey)insteadenchantments are badly named, useEnchantment.getByKey(org.bukkit.NamespacedKey).Enchantments now have a complex effect systems that cannot be reduced to a simple damage increase.Enchantments now have a complex effect systems that cannot be reduced to a simple damage increase.enchantment groupings are now managed by tags, not categoriesenchantments are badly named, useKeyed.getKey().As of 1.20.5 enchantments do not have a rarity.enchantment types are now managed by tagsthis method assumes that the enchantments description always be a translatable component which is not guaranteed.can be attached to multiple blocks useAbstractArrow.getAttachedBlocks()insteadmoved to being a function of the firing weapon, always returns 0 hereUseAbstractArrow.getPickupStatus()as an upstream compatible replacement for this functionmoved to being a function of the firing weapon, does nothing hereUseAbstractArrow.setPickupStatus(PickupStatus)withAbstractArrow.PickupStatusas an upstream compatible replacement for this functiona function of the firing weapon instead, this method does nothingdifferent variants are different classesuseAbstractHorse.isEatingGrass(), this name is incorrectuseAbstractHorse.setEatingGrass(boolean), this name is incorrectyou are required to spawn a different entityshould check what class instance this is.Must spawn a new subtype variantUpgraded / extended potions are now their ownPotionTypeuseAreaEffectCloud.getBasePotionType()instead.Upgraded / extended potions are now their ownPotionTypeuseAreaEffectCloud.setBasePotionType(org.bukkit.potion.PotionType)instead.preferEntityEquipment.getBoots()preferEntityEquipment.getHelmet()Upgraded / extended potions are now their ownPotionTypeuseArrow.getBasePotionType()instead.Upgraded / extended potions are now their ownPotionTypeuseArrow.setBasePotionType(org.bukkit.potion.PotionType)instead.different boats types are now different entity typesboats are complex and many of these methods do not work correctly across multiple versions.boats are complex and many of these methods do not work correctly across multiple versions.boats are complex and many of these methods do not work correctly across multiple versions.deprecated in favor ofBoat.getBoatType()boats are complex and many of these methods do not work correctly across multiple versions.different boats types are now different entity typesboats are complex and many of these methods do not work correctly across multiple versions.boats are complex and many of these methods do not work correctly across multiple versions.boats are complex and many of these methods do not work correctly across multiple versions.deprecated in favor ofBoat.setBoatType(Type)boats are complex and many of these methods do not work correctly across multiple versions.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().useAttribute.MAX_HEALTH.useAttribute.MAX_HEALTH.useAttribute.MAX_HEALTH.this functionality no longer existsthis functionality no longer existsentities may have multiple passengers, useEntity.getPassengers()slightly misleading name, useEntity.getTrackedBy()check the block at the position of the entityuseEntity.isInWater(), bubble column is considered as wateruseEntity.isInWater()andEntity.isInRain()bubble column is considered as water, useEntity.isInWater()andEntity.isInRain()This method can't properly reflect the three possible states of visual fire, useEntity.getVisualFire()insteadmethod is for internal use only and will be removedentities may have multiple passengers, useEntity.addPassenger(org.bukkit.entity.Entity)This method doesn't allow visually extinguishing a burning entity, useEntity.setVisualFire(TriState)insteadMagic valueMagic valueMagic valuefuture versions of Minecraft have additional spell casting entities.future versions of Minecraft have additional spell casting entities.Use getSpawnReason() == EXP_BOTTLEreplaced byEntity.getOrigin()badly named method, returns the value ofFireball.getAcceleration()Use #getAcceleration instead.use #setAcceleration(Vector) instead.has no effect in newer Minecraft versionshas no effect in newer Minecraft versionsonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().should check if instance ofElderGuardian.Must spawn a newElderGuardian.seeChestedHorseseeChestedHorseHumans may now dual wield in their off hand, use explicit methods inPlayerInventory.Misleading name. This method also returns the location of respawn anchors, useOfflinePlayer.getRespawnLocation(boolean)with loadLocationAndValidate = false insteadthis method doesn't take the respawn angle into account, useOfflinePlayer.getRespawnLocation(boolean)with loadLocationAndValidate = false insteadThere are currently no well defined semantics regarding serialized entities in Bukkit. Use with care.There are currently no well defined semantics regarding serialized entities in Bukkit. Use with care.This method should be replaced byMenuType.ANVILseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.CARTOGRAPHY_TABLEseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.ENCHANTMENTseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.GRINDSTONEseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.LOOMseeMenuType.Typed.builder()and its options for more information.This method can be replaced by usingMenuType.MERCHANTin conjunction withHumanEntity.openInventory(InventoryView).This method can be replaced by usingMenuType.MERCHANTin conjunction withHumanEntity.openInventory(InventoryView).This method should be replaced byMenuType.SMITHINGseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.STONECUTTERseeMenuType.Typed.builder()and its options for more information.This method should be replaced byMenuType.CRAFTINGseeMenuType.Typed.builder()and its options for more information.Humans may now dual wield in their off hand, use explicit methods inPlayerInventory.There are currently no well defined semantics regarding serialized entities in Bukkit. Use with care.There are currently no well defined semantics regarding serialized entities in Bukkit. Use with care.useInventoryViewand its children.Unsupported apisound is now client side and cannot be removedno need to force since multiple effects of the same type are now supported.entity groupings are now managed by tags, not categoriesuseLivingEntity.setArrowsInBody(int, boolean). This method previously firedArrowBodyCountChangeEventso if you want to retain exact functionality, passtrueforfireEvent.This does nothing and is immediately reverted by the server, in the next tickHopper minecarts don't have cooldowns anymoreHopper minecarts don't have cooldowns anymoreuseMushroomCow.addEffectToNextStew(io.papermc.paper.potion.SuspiciousEffectEntry, boolean)as PotionEffect suggests that all attributes are used. In fact, only the PotionEffectType and the duration are used.Mushroom cows can now hold multiple effects, useMushroomCow.getStewEffects()Mushroom cows can now hold multiple effects, useMushroomCow.getStewEffects()Mushroom cows can now hold multiple effects, useMushroomCow.setStewEffects(java.util.List)Mushroom cows can now hold multiple effects, useMushroomCow.setStewEffects(java.util.List)Cats are now a separate entity.Cats are now a separate entity.Magic valueMagic valueseeAgeable.setBaby()andAgeable.setAdult()useHumanEntity.fireworkBoost(ItemStack)instead. Note that this method does not check if the player is gliding or not.in favour ofPlayer.displayName()in favour ofPlayer.locale()in favour ofPlayer.playerListFooter()in favour ofPlayer.playerListHeader()in favour ofPlayer.playerListName()This is no longer sent from the client and will always be nullThis value is controlled only by the client and is therefore unreliable and vulnerable to spoofing and/or desync depending on the context/time which it is accessedin favour ofPlayer.kick(net.kyori.adventure.text.Component)Magic valueMagic valueMagic valuesuppressLightUpdates is not functional in versions greater than 1.19.4usesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentThis is unlikely the API you want to use. SeePlayer.sendActionBar(String)for a more proper Action Bar API. This deprecated API may send unsafe items to the client.suppressLightUpdates is no longer available in 1.20+, usePlayer.sendMultiBlockChange(Map)UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())UsePlayer.sendBlockUpdate(Location, TileState)by creating a new virtualSignblock state viaBlockData.createBlockState()(constructed e.g. viaMaterial.createBlockData())Misleading name. This method sets the player's respawn location more generally and is not limited to beds.Misleading name. This method sets the player's respawn location more generally and is not limited to beds.Minecraft no longer uses textures packs. Instead you should usePlayer.setResourcePack(UUID, String, byte[], net.kyori.adventure.text.Component, boolean).usePlayer.getPing()usesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentdoes not do anythingdoes not do anythingUseShearable.readyToBeSheared()instead.UseShearable.shear()instead if applicable. Some entities cannot be "unsheared".in favour ofTextDisplay.text()in favour ofTextDisplay.text(net.kyori.adventure.text.Component)replaced byEntity.getOrigin()in favor ofTurtle.isLayingEgg()This API duplicates existing API which uses the more preferable name due to mirroring internals betterThis API duplicates existing API which uses the more preferable name due to mirroring internals betterThis API duplicates existing API which uses the more preferable name due to mirroring internals betteronly for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().Duplicate api, useWither.getInvulnerableTicks()Duplicate api, useWither.setInvulnerableTicks(int)seeAgeable.setBaby()andAgeable.setAdult()check if instanceofZombieVillager.seeAgeable.setBaby()andAgeable.setAdult()must spawnZombieVillager.Since 1.21.2 all zombie types can break doors if instructed as MC-137053 was fixed.an entity effect can apply to multiple superclasses, seeEntityEffect.getApplicableClasses()slime blocks make the value of this method inaccurate due to blocks being pushed at the sideuseBrewingStartEvent.getBrewingTime()insteaduseBrewingStartEvent.setBrewingTime(int)insteadnot all cauldron contents are Levellednot all cauldron contents are Levellednot all cauldron contents are Levelledin favour ofSignChangeEvent.line(int)in favour ofSignChangeEvent.lines()UsePrepareItemEnchantEvent.getOffers()instead of this methodduration is now a floatnot currently functionalThis does nothing, the server and the client doesn't work correctly when the server try to bypass this. A current workaround exists. If you want to cancel the switch from the ground state to the swimming state you need to disable the sprinting flag for the player after the cancel action.horse jumping was moved client side.horse jumping was moved client side.in favour ofPlayerDeathEvent.deathMessage()in favour ofPlayerDeathEvent.deathMessage(Component)MC 1.14 has changed how villagers restock their trades. UseMerchantRecipe.getUses().MC 1.14 has changed how villagers restock their trades. This has no effect anymore.This changes the ItemStack in their hand before any calculations are applied to the Inventory, which has a tendency to create inconsistencies between the Player and the server, and to make unexpected changes in the behavior of the clicked Inventory.This method uses a deprecated enum fromPlayerPreLoginEventThis method uses a deprecated enum fromPlayerPreLoginEventin favour ofAsyncPlayerPreLoginEvent.kickMessage()This method uses a deprecated enum fromPlayerPreLoginEventin favour ofAsyncPlayerPreLoginEvent.kickMessage(Component)This method uses a deprecated enum fromPlayerPreLoginEventthe respawn point is now set when the player enter the bed and this option doesn't work since MC 1.15.the respawn point is now set when the player enter the bed and this option doesn't work since MC 1.15.has never been functional since its implementation and simply returns the old main hand. The method is left in this broken state to not break compatibility with plugins that relied on this fact. UsePlayerChangedMainHandEvent.getNewMainHand()instead or migrate toPlayerClientOptionsChangeEvent.getMainHand().This is simply the online players. Modifications have no effectOnly works for sign commands; usePlayer.performCommand(String), including those casesbooks may be signed from off handmisleading, usePlayerInteractEvent.getInteractionPoint()This event has two possible cancellation states, one forPlayerInteractEvent.useInteractedBlock()and one forPlayerInteractEvent.useItemInHand(). It is possible a call might have the former false, but the lattertrue, e.g. in the case of using a firework whilst gliding. Callers should check the relevant methods individually.the mending enchantment uses enchantment effects to compute how much durability is granted per xp. The enchantment effects operation are too complex to reliably offer the inverse function.the mending enchantment uses enchantment effects to compute how much durability is granted per xp. The enchantment effects operation are too complex to reliably offer the inverse function.in favour ofPlayerJoinEvent.joinMessage()in favour ofPlayerJoinEvent.joinMessage(Component)in favour ofPlayerKickEvent.leaveMessage()in favour ofPlayerKickEvent.reason()in favour ofPlayerLocaleChangeEvent.locale()in favour ofPlayerLoginEvent.disallow(Result, Component)in favour ofPlayerLoginEvent.kickMessage()in favour ofPlayerLoginEvent.kickMessage(Component)No effectNo effectin favour ofPlayerPreLoginEvent.kickMessage()in favour ofPlayerPreLoginEvent.kickMessage(Component)in favour ofPlayerQuitEvent.quitMessage()in favour ofPlayerQuitEvent.quitMessage(Component)This is no longer sent from the client and will always be nulldismounting on tp is no longer controlled by the serverin favour ofBroadcastMessageEvent.message()in favour ofBroadcastMessageEvent.message(Component)in favour ofServerListPingEvent.motd()the Iterable interface will be removed at some pointin favour ofServerListPingEvent.motd(Component)chat previews have been removedonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().UseRegistry.get(NamespacedKey)instead.useIterable.iterator().biomes are now 3-dimensionalbiomes are now 3-dimensionalUses magic valuesChunkGenerator.ChunkDataare now directly providedThe generation is now split up and the new methods should be used, seeChunkGeneratorthe chunk generation code should be thread safehas no effect, bedrock generation is part of the surface step, seeChunkGenerator.shouldGenerateSurface()useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.STRUCTURE. Structures can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.STRUCTURE. Structures can exist without a key.Magic valueMagic valueUseCookingRecipe.getInputChoice()instead for more complete data.entities can duel wield now use the methods for the specific hand insteadentities can duel wield now use the methods for the specific hand insteadentities can duel wield now use the methods for the specific hand insteadentities can duel wield now use the methods for the specific hand insteadfor internal compatibility use onlyMagic valuechanging the title is not supportedin favour ofInventoryView.title()changing the title is not supported. This method has poorly defined and broken behaviors. It should not be used.useItemFactory.enchantWithLevels(ItemStack, int, boolean, java.util.Random). This method's implementation is poorly designed and was originally broken.useItemFactory.enchantWithLevels(ItemStack, int, boolean, java.util.Random). This method's implementation is poorly designed and was originally broken.useItemFactory.enchantWithLevels(ItemStack, int, boolean, java.util.Random). This method's implementation is poorly designed and was originally broken.ItemStackimplementsTranslatable; use that andComponent.translatable(net.kyori.adventure.translation.Translatable)instead.cast toBlockDataMetaand useBlockDataMeta.getBlockData(Material)ItemStackimplementsTranslatable; use that andComponent.translatable(net.kyori.adventure.translation.Translatable)instead.in favor ofItemStack.lore()useItemStack.getMaxItemUseDuration(org.bukkit.entity.LivingEntity); crossbows, later possibly more items require an entity parameterdurability is now part of ItemMeta. To avoid confusion and misuse,ItemStack.getItemMeta(),ItemStack.setItemMeta(ItemMeta)andDamageable.setDamage(int)should be used instead. This is because any call to this method will be overwritten by subsequent setting of ItemMeta which was created before this call.in favour ofItemStack.lore(java.util.List)Setting the material type of ItemStacks is no longer supported.This method is deprecated due to potential illegal behavior that may occur during the context of which this ItemStack is being used, allowing for certain item validation to be bypassed. It is recommended to instead create a new ItemStack object with the desired Material type, and if possible, set it in the appropriate context. Using this method in ItemStacks passed in events will result in undefined behavior.
only for internal useUseMenuType.Typed.create(HumanEntity, Component)instead.useBook.pages()useBook.pages(List)in favour ofBookMeta.page(int)in favour ofBook.pages()in favour ofBook.pages(java.util.List)in favour ofBook.pages(net.kyori.adventure.text.Component...)no longer available on the component directlyno longer available on the component directlythis API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_BREAKinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_PLACE_ONinstead of this.more complex custom model data can be specified withItemMeta.getCustomModelDataComponent(). Integers from the old custom model data are equivalent to a single float in theCustomModelDataComponent.getFloats()list.this API part has been replaced by thePersistentDataHolderAPI. Please usePersistentDataHolder.getPersistentDataContainer()instead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_BREAKinstead of this.in favour ofItemMeta.displayName()in favour ofItemMeta.itemName()UseItemMeta.displayName()and cast it to aTranslatableComponent. No longer used by the client.in favour ofItemMeta.lore()useItemMeta.lore()this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.getData(DataComponentType.Valued)withDataComponentTypes.CAN_PLACE_ONinstead of this.more complex custom model data can be specified withItemMeta.hasCustomModelDataComponent(). Integers from the old custom model data are equivalent to a single float in theCustomModelDataComponent.getFloats()list.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.hasData(DataComponentType)withDataComponentTypes.CAN_BREAKinstead of this.UseItemMeta.displayName()and check if it is instanceof aTranslatableComponent.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.hasData(DataComponentType)withDataComponentTypes.CAN_PLACE_ONinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_BREAKinstead of this.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_PLACE_ONinstead of this.more complex custom model data can be specified withItemMeta.setCustomModelDataComponent(org.bukkit.inventory.meta.components.CustomModelDataComponent). Integers from the old custom model data are equivalent to a single float in theCustomModelDataComponent.setFloats(java.util.List)list.this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_BREAKinstead of this.in favour ofItemMeta.itemName(Component)UseItemMeta.displayName(Component)with aTranslatableComponent. No longer used by the client.in favour ofItemMeta.lore(List)this API part has been replaced by theItemAdventurePredicateAPI. Please useItemStack.setData(DataComponentType.Valued, Object)withDataComponentTypes.CAN_PLACE_ONinstead of this.This method does not have the expected effect and is actually an alias forItemMeta.getLocalizedName().This method does not have the expected effect and is actually an alias forItemMeta.hasLocalizedName().This method does not have the expected effect and is actually an alias forItemMeta.setLocalizedName(String).These methods are poor API: They rely on the caller to pass in an only an integer property, and have poorly defined implementation behavior if that integer is not a valid map (the current implementation for example will generate a new map with a different ID). The xxxMapView family of methods should be used instead.Upgraded / extended potions are now their ownPotionTypeusePotionMeta.getBasePotionType()instead.conflicting name, usePotionMeta.getCustomPotionName()conflicting name, usePotionMeta.hasCustomPotionName()Upgraded / extended potions are now their ownPotionTypeusePotionMeta.setBasePotionType(org.bukkit.potion.PotionType)instead.conflicting name, usePotionMeta.setCustomPotionName(String)different types are different itemsdifferent types are different itemsuseSuspiciousStewMeta.addCustomEffect(io.papermc.paper.potion.SuspiciousEffectEntry, boolean)as PotionEffect suggests that all attributes are used. In fact, only the PotionEffectType and the duration are used.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.this method assumes thatTrimMaterial.description()will always be a translatable component which is not guaranteed.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_MATERIAL. TrimMaterials can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_PATTERN. TrimPatterns can exist without a key.this method assumes thatTrimPattern.description()will always be a translatable component which is not guaranteed.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.TRIM_PATTERN. TrimPatterns can exist without a key.players can duel wield now use the methods for the specific hand insteadplayers can duel wield now use the methods for the specific hand insteadfor compatibility onlyUseShapedRecipe.getChoiceMap()instead for more complete data.Magic valueMagic valueMagic valueUseShapelessRecipe.getChoiceList()instead for more complete data.Magic valueMagic valueUseStonecuttingRecipe.getInputChoice()instead for more complete data.this method assumes that jukebox song description will always be a translatable component which is not guaranteed.only encodes y block ranges from -512 to 511 and represents an already changed implementation detailno longer functionalno longer functionalMagic value, useMapCanvas.setPixelColor(int, int, Color)in favour ofMapCursor.caption()only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().Magic valueMagic valueMagic valueMagic valueuse color directlyuse color-related methodsuse color-related methodsuse color-related methodsThis method should not be used; use hinge and facing accessors instead.Magic valueMagic valueuseMaterial.isAir()This method is not comprehensive and does not accurately reflect what block types are interactable. Many "interactions" are defined on the item not block, and many are conditional on some other world state checks being true.currently does not have an implementation which is well linked to the underlying server. Contributions welcome.Magic valueMagic valuethis method creates an ItemStack of size 0 which is not generally useful. ConsiderMaterialData.toItemStack(int).Use MushroomBlockType cap optionsMagic valueThis is now stored inSpawnEggMeta.This is now stored inSpawnEggMeta.Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueuseRegistry.get(NamespacedKey)insteaduseRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.INSTRUMENT. MusicInstruments can exist without a key.useRegistry.getKey(Keyed),RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), andRegistryKey.INSTRUMENT. MusicInstruments can exist without a key.this method assumes that the instrument description always be a translatable component which is not guaranteed.in favour ofNameable.customName()should never be used by plugins, for internal use only!!Misleading name. This method also returns the location of respawn anchors.The API contract is ambiguous and the implementation may or may not return the correct value given this API ambiguity. It is instead recommended useOfflinePlayer.getLastLogin()orOfflinePlayer.getLastSeen()depending on your needs.No longer applicable to all types of pluginsPlugin loading now occurs at a point which makes it impossible to expose this behavior. This instance will only throw unsupported operation exceptions.only calls thePlayerversion of onPluginMessageReceived, useMessenger.dispatchIncomingMessage(PlayerConnection, String, byte[])instead to call both.not an API methodnot an API methodMay be inaccurate due to different plugin implementations.unusedusePotionEffectType.createEffect(int, int)instead.Upgraded / extended potions are now their ownPotionTypeusePotionType.getPotionEffects()insteadNon-Functionalcolor is not part of potion effectsonly for backwards compatibility, useRegistry.get(NamespacedKey)instead.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.unused, always 1.0useKeyed.key()only for backwards compatibility, useKeyed.getKey()instead.useIterable.iterator().MisleadingPotions can have multiple effects usePotionType.getPotionEffects()PotionType can have multiple effects, some of which can be instant and others not. UsePotionEffectType.isInstant()in combination withPotionType.getPotionEffects()andPotionEffect.getType()Raid identifiers are magic internal values and may or may not be present. -1 is returned for raids without an assigned id.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 aNamespacedKeyobject and useRegistry.get(NamespacedKey)Magic valueMagic valueThis name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskThis name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskThis name is misleading, as it does not schedule "a sync" task, but rather, "an async" taskin favour ofObjective.displayName()Scoreboards can contain entries that aren't playersScoreboards can contain entries that aren't playersa displayName should be explicitly specifiedin favour ofTeam.color()in favour ofTeam.displayName()Teams can contain entries that aren't playersin favour ofTeam.prefix()in favour ofTeam.suffix()in favour ofTeam.displayName(net.kyori.adventure.text.Component)in favour ofTeam.prefix(net.kyori.adventure.text.Component)in favour ofTeam.suffix(net.kyori.adventure.text.Component)usesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentin favour ofServer.createMerchant(net.kyori.adventure.text.Component), The title parameter is no-longer needed when used withMenuType.MERCHANTandMenuType.Typed.builder().The title parameter is no-longer needed when used withMenuType.MERCHANTandMenuType.Typed.builder().Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)useServer.getBanList(io.papermc.paper.ban.BanListType)to enforce the correct return value at compile time.Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)in favour ofServer.motd()useRegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey)with keys fromRegistryKeyin favour ofServer.shutdownMessage()Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)in favour ofServer.motd(net.kyori.adventure.text.Component)chat previews have been removedAll methods on this class have been deprecated, see the individual methods for replacements.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.Server config options may be renamed or removed without notice. Prefer using existing API wherever possible, rather than directly reading from a server config.UseServer.restart()instead.in favour ofServerLinks.ServerLink.displayName()useRegistry.getKey(Keyed)andRegistry.SOUNDS. Sounds can exist without a key.useRegistry.getKey(Keyed)andRegistry.SOUNDS. Sounds can exist without a key.only for backwards compatibility, useRegistry.get(NamespacedKey)instead.useIterable.iterator().look for atranslationKey()method insteadMagic valueMagic valuecustom biomes are properly supported in API nowthe color is no longer available to the servercustom biomes are properly supported in API nowonly for backwards compatibility, old enums can not be compared.only for backwards compatibility.only for backwards compatibility, it is not guaranteed that an old enum always has the same ordinal.unused as of 1.19in favor ofRegionAccessor.generateTree(Location, java.util.Random, TreeType)to specify its own random instance and this method is not accessible throughRegionAccessorthis method does not handle block entities (bee nests)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)biomes are now 3-dimensionalonly encodes y block ranges from -512 to 511 and represents an already changed implementation detailUse either the Future or the Consumer based methodsUse either the Future or the Consumer based methodsUse either the Future or the Consumer based methodsuseWorld.getGameRuleValue(GameRule)insteadbiomes are now 3-dimensionalNo longer functional since 1.21.9, the vanilla server does not have the concept of spawn chunks anymore.Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)useGameRule.PVPinsteadbiomes are now 3-dimensionalDeprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getTicksPerSpawns(SpawnCategory)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)world type is only used to select the default word generation settings and is not stored in Vanilla worlds, making it impossible for this method to always return the correct value.This method was added to facilitate chunk garbage collection. As of the current Minecraft version chunks are now strictly managed and will not be loaded for more than 1 tick unless they are in use.regenerating a single chunk is not likely to produce the same chunk as before as terrain decoration may be spread across chunks. It may or may not change blocks in the adjacent chunks as well.Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)Deprecated in favor ofWorld.getSpawnLimit(SpawnCategory)biomes are now 3-dimensionaluseWorld.setGameRule(GameRule, Object)instead.No longer functional since 1.21.9, the vanilla server does not have the concept of spawn chunks anymore.Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)useGameRule.PVPinsteadDeprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setTicksPerSpawns(SpawnCategory, int)Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)Magic value. UseRegionAccessor.spawn(Location, Class, Consumer)(or a variation thereof) in combination withFallingBlock.setBlockData(BlockData)UseRegionAccessor.spawn(Location, Class, Consumer)(or a variation thereof) in combination withFallingBlock.setBlockData(BlockData)UseRegionAccessor.spawn(Location, Class, Consumer)(or a variation thereof) in combination withFallingBlock.setBlockData(BlockData)Unsupported apisound is now client side and cannot be removedsound is now client side and cannot be removedcompletely unfunctional as the server no longer has always loaded spawn chunks.completely unfunctional as the server no longer has always loaded spawn chunks.
-
Deprecated ConstructorsConstructorDescriptionUse NamespacedKey version of constructorUse NamespacedKey version of constructorUse NamespacedKey version of constructorshould never be used by plugins, for internal use only!!options requiredoptions requiredorg.bukkit.event.player.PlayerBucketEmptyEvent
(Player, Block, Block, BlockFace, Material, ItemStack) this method uses an ambiguous data byte objectRecipes must have keys. UseShapedRecipe(NamespacedKey, ItemStack)instead.as of Minecraft 1.20, smithing recipes are now separated into two distinct recipe types,SmithingTransformRecipeandSmithingTrimRecipe. This class now acts as a base class to these two classes and will do nothing when added to the server.Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueArtifact of old API, equivalent to newDoor(Material.LEGACY_WOODEN_DOOR);Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic value
-
Deprecated Enum ConstantsEnum ConstantDescriptionno longer used anymore since 1.15.2, the value fallback to the default value of the setting when unknown on the server. In this case
ClientOption.ChatVisibility.FULLwill be returned.This is the default behavior now.Removed as it causes a warning to appear on the client now.deprecated in favor ofBanList.Type.PROFILEno longer existsno longer existsNo longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existspartially replaced byEffect.BEE_GROWTHthis target no longer exists in Vanillasplit into individual effectsraid system was overhauled in 1.20.5split into individual effectsreplaced by theblocks_attacksitem data componentreplaced by theblocks_attacksitem data componentno longer called, chunks are generated with entities already existing. Consider usingChunkLoadEvent,ChunkLoadEvent.isNewChunk()andChunk.getEntities()for similar effect.never used without help of commands or plugins,EntityDamageEvent.DamageCause.ENTITY_ATTACKwill be used insteadno longer used, player now gets an ominous bottle insteadThis action no longer happens, they are allInventoryAction.HOTBAR_SWAPs.does not exist anymore and will not properly work with individually hidden data components; seeTooltipDisplayandItemStack.setData(DataComponentType.Valued, Object)all plugins are now assumed to be UTF-8 aware.