Deprecated API
Contents
-
InterfacesInterfaceDescriptionfor removal with 1.17, in favour of
ChatRendererdoes not provide useful information beyond the material itselflingering status depends on only on the potion item.splash status depends on only on the potion item.tipped status depends only on base potion type not being UNCRAFTABLE and effects being empty.this 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 replacedUse either the Future or the Consumer based methods
-
ClassesClassDescriptionBukkit has added
EntityTransformEvent, you should start using thatNot usedUsePlayerSpawnLocationEvent, Duplicate APIReplaced byPlayerLocaleChangeEventupstreamDraft APIuseTitleListening to this event forces chat to wait for the main thread, delaying chat messages. It is recommended to useAsyncChatEventinstead, wherever possible.useAsyncChatEventinsteadUse the more genericPlayerBucketEntityEventThis event will fire from the main thread and allows the use of all of the Bukkit API, unlike theAsyncPlayerChatEvent.Listening to this event forces chat to wait for the main thread which causes delays for chat.
AsyncPlayerChatEventis the encouraged alternative for thread safe implementations.This event is no longer fired due to client changesThis 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.
-
Enum ClassesEnum ClassDescriptionUpstream has added their own API for using the game heightmaps. See
HeightMapand the non-deprecated getHighestBlock methods on World such asWorld.getHighestBlockAt(Location, HeightMap).future versions of Minecraft have additional spell casting entities.different variants are differing classesCats are now a separate entity.This API is responsible for a large number of implementation problems and is in general unsustainable to maintain. It is likely to be removed very soon in a subsequent release. Please see https://www.spigotmc.org/threads/194446/ for more information.replaced byTeam.OptionStatuscheckMaterialinstead
-
Annotation InterfacesAnnotation InterfaceDescriptionThis should generally not be used in any new API code as it suggests a bad API design.
-
FieldsFieldDescriptionremoved in 1.16removed in 1.16Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic value
-
MethodsMethodDescriptionDoesn't do anything - Removedshould never be used by plugins, for internal use only!!for removal with 1.17for removal with 1.17for removal with 1.17, in favour of
AbstractChatEvent.renderer()for removal with 1.17, in favour ofAbstractChatEvent.renderer(ChatRenderer)for removal with 1.17, in favour ofAbstractChatEvent.renderer()for removal with 1.17, in favour ofAbstractChatEvent.renderer(ChatRenderer)for removal with 1.17, in favor ofAbstractChatEvent.viewers()Magic valueMagic valueMagic valueMagic valueMagic valuemagic value, useCreatureSpawner.getSpawnedType().magic value, useCreatureSpawner.setSpawnedType(org.bukkit.entity.EntityType).Magic valueMagic valuein favour ofSign.line(int)in favour ofSign.lines()in favour ofSign.line(int, net.kyori.adventure.text.Component)useBlockDatacheckMaterialinsteaduseBlockDatacheckMaterialinsteadin favour ofServer.broadcast(net.kyori.adventure.text.Component)Magic valuein favour ofBukkit.motd()Persistent storage of users should be by UUID as names are no longer unique past a single session.in favour ofBukkit.shutdownMessage()biomes are now 3-dimensionalMagic valuebiomes are now 3-dimensionalMagic valueMagic valueusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentusesendMessagemethods that acceptComponentMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valuelegacy use onlyMagic valueMagic valueenchantments are badly named, useEnchantment.getByKey(org.bukkit.NamespacedKey).enchantments are badly named, useEnchantment.getKey().cursed enchantments are no longer special. Will return true only forEnchantment.BINDING_CURSEandEnchantment.VANISHING_CURSE.UseAbstractArrow.getPickupStatus()as an upstream compatible replacement for this functionUseAbstractArrow.setPickupStatus(PickupStatus)withAbstractArrow.PickupStatusas an upstream compatible replacement for this functiondifferent variants are different classesyou are required to spawn a different entitypreferEntityEquipment.getBoots()preferEntityEquipment.getHelmet()preferArmorStand.getItem(EquipmentSlot)// PaperpreferArmorStand.setItem(EquipmentSlot, ItemStack)// Paperboats 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.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.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.boats are complex and many of these methods do not work correctly across multiple versions.entities may have multiple passengers, useEntity.getPassengers()entities may have multiple passengers, useEntity.addPassenger(org.bukkit.entity.Entity)Magic valueMagic 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()has no effect in newer Minecraft versionshas no effect in newer Minecraft versionsshould check if instance ofElderGuardian.Must spawn a newElderGuardian.seeChestedHorseseeChestedHorseHumans 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.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.no need to force since multiple effects of the same type are now supported.Magic valueMagic valueseeAgeable.setBaby()andAgeable.setAdult()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 is unimplemented and will throw an exception at runtime. TheWorld-based methods still work.This 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 valueMagic valueusesendMessagemethods 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.API behavior subject to changeMinecraft no longer uses textures packs. Instead you should usePlayer.setResourcePack(String).This is unimplemented and will throw an exception at runtime. TheWorld-based methods still work.This 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.usesendMessagemethods 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.should check what class instance this isMust spawn a new subtype variantreplaced byEntity.getOrigin()seeAgeable.setBaby()andAgeable.setAdult()check if instanceofZombieVillager.seeAgeable.setBaby()andAgeable.setAdult()must spawnZombieVillager.Magic valueslime blocks make the value of this method inaccurate due to blocks being pushed at the sideno effect on newer Minecraft versionsno effect on newer Minecraft versionsin favour ofSignChangeEvent.line(int)in favour ofSignChangeEvent.lines()UsePrepareItemEnchantEvent.getOffers()instead of this methodhorse jumping was moved client side.horse jumping was moved client side.in favour ofPlayerDeathEvent.deathMessage()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 fromPlayerPreLoginEventThis method uses a deprecated enum fromPlayerPreLoginEventThis method is provided for backward compatibility with no guarantee to the effect of viewing or modifying the set.books may be signed from off handThis 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 latter true, eg in the case of using a firework whilst gliding. Callers should check the relevant methods individually.in favour ofPlayerJoinEvent.joinMessage()in favour ofPlayerKickEvent.leaveMessage()in favour ofPlayerKickEvent.reason()in favour ofPlayerLocaleChangeEvent.locale()in favour ofPlayerLoginEvent.kickMessage()in favour ofPlayerPreLoginEvent.kickMessage()in favour ofPlayerQuitEvent.quitMessage()in favour ofBroadcastMessageEvent.message()in favour ofServerListPingEvent.motd()Magic valueMagic valuebiomes are now 3-dimensionalbiomes are now 3-dimensionalUses magic valuesMagic valueMagic valueMagic valueMagic valueentities 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 insteadMagic valuein favour ofInventoryView.title()Magic valuefor internal use onlyin favor ofItemStack.lore()durability 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(List)banner color is now stored as the data value, not meta.banner color is now stored as the data value, not meta.in favour ofBookMeta.page(int)in favour ofBook.pages()in favour ofBook.pages(net.kyori.adventure.text.Component...)in favour ofBook.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...)Minecraft does not limit this to the material enum, UseItemMeta.getDestroyableKeys()as a replacementMinecraft does not limit this to the material enum, UseItemMeta.getPlaceableKeys()as a replacementthis API part has been replaced by thePersistentDataHolderAPI. Please usePersistentDataHolder.getPersistentDataContainer()instead of this.in favour ofItemMeta.displayName()in favour ofItemMeta.lore()useItemMeta.lore()Minecraft does not limit this to the material enum, UseItemMeta.setDestroyableKeys(Collection)as a replacementMinecraft does not limit this to the material enum, UseItemMeta.setPlaceableKeys(Collection)as a replacementin favour ofItemMeta.lore(List)internal use onlyThese 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.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.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.different types are different itemsdifferent types are different itemsplayers 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 onlyMagic valueMagic valueMagic valueMagic valueMagic valuein favour ofMapCursor.caption()Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueThis method should not be used; use hinge and facing accessors instead.Magic valueMagic valueMagic valuecurrently 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 valueshould never be used by plugins, for internal use only!!Magic valueMagic valueMagic valueMagic valueMagic valueThe 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.not an API methodnot an API methodunusedInternal useNon-functionalNon-functionalNon-Functionalcolor is not part of potion effectsMagic valueunused, always 1.0Magic valueMisleadingMagic valueMagic valueorg.bukkit.scheduler.BukkitScheduler.runTaskTimerAsynchronously(Plugin, BukkitRunnable, long, long)This 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 playersScoreboards can contain entries that aren't playersScoreboards can contain entries that aren't playersScoreboards can contain entries that aren't playersa displayName should be explicitly specifiedScoreboards can contain entries that aren't playersTeams can contain entries that aren't playersin favour ofTeam.color()in favour ofTeam.displayName()Teams can contain entries that aren't playersin favour ofTeam.prefix()in favour ofTeam.suffix()Teams can contain entries that aren't playersTeams can contain entries that aren't playersin 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 acceptComponentMagic valuein favour ofServer.motd()Persistent storage of users should be by UUID as names are no longer unique past a single session.in favour ofServer.shutdownMessage()Magic valueMagic valueMagic valueMagic valuebiomes are now 3-dimensionalUse 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)insteadUpstream has added support for this, useWorld.getHighestBlockAt(int, int, HeightMap)Upstream has added support for this, useWorld.getHighestBlockAt(Location, HeightMap)Upstream has added support for this, useWorld.getHighestBlockYAt(int, int, HeightMap)Upstream has added support for this, useWorld.getHighestBlockYAt(Location, HeightMap)biomes are now 3-dimensionalbiomes are now 3-dimensionalworld 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.This method is not guaranteed to work suitably across all client implementations.regenerating a single chunk is not likely to produce the same chunk as before as terrain decoration may be spread across chunks. Use of this method should be avoided as it is known to produce buggy results.biomes are now 3-dimensionaluseWorld.setGameRule(GameRule, Object)instead.Magic valueuseWorldBorder.isInside(Location)for an upstream compatible replacement
-
ConstructorsConstructorDescriptionUse NamespacedKey version of constructorUse NamespacedKey version of constructorUse NamespacedKey version of constructorshould never be used by plugins, for internal use only!!for removal with 1.17, use
AsyncChatEvent(boolean, Player, Set, ChatRenderer, Component, Component)io.papermc.paper.event.player.AsyncChatEvent(boolean, Player, Set<Player>, ChatComposer, Component)for removal with 1.17, useAsyncChatEvent(boolean, Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useAsyncChatEvent(boolean, Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useAsyncChatEvent(boolean, Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useAsyncChatEvent(boolean, Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useChatEvent(Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useChatEvent(Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useChatEvent(Player, Set, ChatRenderer, Component, Component)for removal with 1.17, useChatEvent(Player, Set, ChatRenderer, Component, Component)this method uses an ambiguous data byte objectMagic 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 valueshould never be used by plugins, for internal use only!!In favour of usingPotion(PotionType)withPotion.splash().
-
Enum ConstantsEnum ConstantDescriptionthis target no longer exists in Vanillaalthough this effect may trigger other events on non-living entities, it's only supported usage is on living ones.although this effect may trigger other events on non-living entities, it's only supported usage is on living ones.no longer called, chunks are generated with entities already existing. Consider using
ChunkLoadEvent,ChunkLoadEvent.isNewChunk()andChunk.getEntities()for similar effect.all plugins are now assumed to be UTF-8 aware.
ChatRenderer