Deprecated API
Contents
-
ElementDescriptionTimings will likely be replaced with Spark in the futureTimings will likely be replaced with Spark in the futureTimings will likely be replaced with Spark in the futureuse
SoundGroup
useRayTraceResult
useRayTraceResult
useTNTPrimeEvent
Bukkit has addedEntityTransformEvent
, you should start using thatUsePlayerSpawnLocationEvent
, Duplicate APIReplaced byPlayerLocaleChangeEvent
upstreamUpstream has added their own API for using the game heightmaps. SeeHeightMap
and the non-deprecated getHighestBlock methods on World such asWorld.getHighestBlockAt(org.bukkit.Location, org.bukkit.HeightMap)
.Draft APIchat preview was removed in 1.19.3no longer used, seeStructuresLocateEvent
will be removed in adventure 5.0.0, usePlainTextComponentSerializer.plainText()
useStructure
The new multi-stage worldgen API allows a similar effect by overriding all of the "shouldGenerate..." methods to return true, and then modifying the chunkdata in a later stage such as surface or bedrock generation.should not be used for anything, useThrownPotion
and set the potion via the methods there.Hopper minecarts don't have cooldowns anymoreHopper minecarts don't have cooldowns anymoreMushroom 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)
This is no longer sent from the client and will always be nulldoes not do anythingdoes not do anythingshould not be used for anything, useThrownPotion
and set the potion via the methods there.Duplicate api, useWither.getInvulnerableTicks()
Duplicate api, useWither.setInvulnerableTicks(int)
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.Hash does not seem to ever be setdismounting on tp is no longer controlled by the serverdifferent types are different itemsdifferent types are different itemsuseRegistry.getKey(Keyed)
andRegistry.TRIM_MATERIAL
. TrimMaterials can exist without a key.useRegistry.getKey(Keyed)
andRegistry.TRIM_PATTERN
. TrimPatterns can exist without a key.use color directlyuse color-related methodsuse color-related methodsuse color-related methodsuseDatapack
useDatapackManager
Plugin loading now occurs at a point which makes it impossible to expose this behavior. This instance will only throw unsupported operation exceptions.useKeyed.key()
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 aNamespacedKey
object and useRegistry.get(NamespacedKey)
The new multi-stage worldgen API allows a similar effect by overriding all of the "shouldGenerate..." methods to return true, and then modifying the chunkdata in a later stage such as surface or bedrock generation.useTranslatable
look for atranslationKey()
method insteadunused as of 1.19Upstream 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, useRegionAccessor.getHighestBlockYAt(int, int, HeightMap)
Upstream has added support for this, useRegionAccessor.getHighestBlockYAt(Location, HeightMap)
useWorldBorder.isInside(Location)
for an upstream compatible replacement
-
InterfaceDescriptionTimings will likely be replaced with Spark in the futureuse
SoundGroup
should not be used for anything, useThrownPotion
and set the potion via the methods there.should not be used for anything, useThrownPotion
and set the potion via the methods there.tipped status depends only on base potion type not being UNCRAFTABLE and effects being empty.Biomes are now set withBiomeProvider
this API part has been replaced by thePersistentDataHolder
API. Please usePersistentDataHolder
instead of this.this API part has been replaced byPersistentDataHolder
. Please usePersistentDataAdapterContext
instead of this.please usePersistentDataType
as this part of the api is being replaceduseDatapack
useDatapackManager
Do not use, interface will get removed, and the plugin won't runseePlayerProfile
useTranslatable
UseConsumer
insteadUse either the Future or the Consumer based methods
-
ClassDescriptionTimings will likely be replaced with Spark in the futureTimings will likely be replaced with Spark in the futureuse
RayTraceResult
useRayTraceResult
useTNTPrimeEvent
Bukkit has addedEntityTransformEvent
, you should start using thatDeprecated, useProjectileHitEvent
and check if there is a hit entityNot usedUsePlayerSpawnLocationEvent
, Duplicate APIReplaced byPlayerLocaleChangeEvent
upstreamDraft APIuseTitle
useBellRingEvent
Listening to this event forces chat to wait for the main thread, delaying chat messages. It is recommended to useAsyncChatEvent
instead, wherever possible.no longer used, seeStructuresLocateEvent
useStructure
only for backwards compatibility, EnchantmentWrapper is no longer used.Unsupported apiuseAsyncChatEvent
insteadchat previews have been removedUse the more genericPlayerBucketEntityEvent
Listening to this event forces chat to wait for the main thread, delaying chat messages. It is recommended to useAsyncChatEvent
instead, wherever possible.This event is no longer fired due to client changesThis event causes synchronization from the login thread;AsyncPlayerPreLoginEvent
is 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
.useSpawnEggMeta
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
.Upgraded / extended potions are now their ownPotionType
use them instead.only for backwards compatibility, PotionEffectTypeWrapper is no longer used.use the constants declared inCriteria
insteadThis class does not represent the structures of a world well. UseStructure
orStructureType
instead.replaced byEntityDismountEvent
. This event will never be called directly and instead will be dynamically replaced byEntityDismountEvent
.replaced byEntityMountEvent
. This event will never be called directly and instead will be dynamically replaced byEntityMountEvent
.
-
Enum ClassDescriptionUpstream has added their own API for using the game heightmaps. See
HeightMap
and the non-deprecated getHighestBlock methods on World such asWorld.getHighestBlockAt(org.bukkit.Location, org.bukkit.HeightMap)
.ChatColor has been deprecated in favor of Adventure API. SeeNamedTextColor
for the adventure equivalent of pre-defined text colorsnot representative of what Effect doesfuture 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. It is likely to be removed very soon in a subsequent release. Please see https://www.spigotmc.org/threads/194446/ for more information.useBlockData
use BlockDatauseBlockData
replaced byTeam.OptionStatus
checkMaterial
insteadDeprecated, see usage methods for replacement(s)
-
Annotation InterfaceDescriptionThis should generally not be used in any new API code as it suggests a bad API design.
-
FieldDescriptionunused, not intended to be APIunused, not intended to be APInot available since 1.20Magic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueMagic valueUse
PersistentDataType.LIST
'sListPersistentDataTypeProvider.dataContainers()
instead asListPersistentDataType
s offer full support for primitive types, such as thePersistentDataContainer
.
-
MethodDescriptionDoesn't do anything - Removedshould never be used by plugins, for internal use only!!check if
WaterBottleSplashEvent.getToDamage()
contains an entityuseWaterBottleSplashEvent.damageAsWaterSensitive(LivingEntity)
orWaterBottleSplashEvent.doNotDamageAsWaterSensitive(LivingEntity)
to change which entities are damagedchat preview was removed in 1.19.3will be removed in adventure 5.0.0, usePlainTextComponentSerializer.plainText()
This return a generic class, prefer useBanList.getEntries()
magic value, useRegistry.get(NamespacedKey)
insteadmagic valueonly encodes y block ranges from -512 to 511 and represents an already changed implementation detailMagic valueMagic valueMagic valuein favour ofCommandBlock.name()
magic value, useCreatureSpawner.getSpawnedType()
.magic value, useCreatureSpawner.setSpawnedType(org.bukkit.entity.EntityType)
.in favor ofDecoratedPot.getSherds()
A 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()
useBlockData
checkMaterial
insteaduseBlockData
checkMaterial
insteadin favour ofServer.broadcast(net.kyori.adventure.text.Component)
The new multi-stage worldgen API allows a similar effect by overriding all of the "shouldGenerate..." methods to return true, and then modifying the chunkdata in a later stage such as surface or bedrock generation.Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)
Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)
Deprecated in favor ofBukkit.getSpawnLimit(SpawnCategory)
in favour ofBukkit.motd()
in 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(net.kyori.adventure.text.Component)
chat previews have been removedbiomes are now 3-dimensionalMagic valuebiomes are now 3-dimensionalMagic valueMagic valuesender UUID is ignoredsender UUID is ignoredusesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
This 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 neitheronly for backwards compatibility, useRegistry.get(NamespacedKey)
insteadenchantments are badly named, useEnchantment.getByKey(org.bukkit.NamespacedKey)
.enchantments are badly named, useKeyed.getKey()
.UseAbstractArrow.getPickupStatus()
as an upstream compatible replacement for this functionUseAbstractArrow.setPickupStatus(PickupStatus)
withAbstractArrow.PickupStatus
as an upstream compatible replacement for this functiondifferent 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 ownPotionType
useAreaEffectCloud.getBasePotionType()
instead.Upgraded / extended potions are now their ownPotionType
useAreaEffectCloud.setBasePotionType(org.bukkit.potion.PotionType)
instead.preferEntityEquipment.getBoots()
preferEntityEquipment.getHelmet()
preferArmorStand.getItem(EquipmentSlot)
// PaperpreferArmorStand.setItem(EquipmentSlot, ItemStack)
// PaperUpgraded / extended potions are now their ownPotionType
useArrow.getBasePotionType()
instead.Upgraded / extended potions are now their ownPotionType
useArrow.setBasePotionType(org.bukkit.potion.PotionType)
instead.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.deprecated in favor ofBoat.getBoatType()
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.deprecated in favor ofBoat.setBoatType(Type)
boats are complex and many of these methods do not work correctly across multiple versions.entities may have multiple passengers, useEntity.getPassengers()
slightly misleading name, useEntity.getTrackedBy()
entities may have multiple passengers, useEntity.addPassenger(org.bukkit.entity.Entity)
Magic 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
.seeChestedHorse
seeChestedHorse
Humans may now dual wield in their off hand, use explicit methods inPlayerInventory
.Deprecated in favor ofLivingEntity.getActiveItem()
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.Unsupported apisound is now client side and cannot be removedno need to force since multiple effects of the same type are now supported.useLivingEntity.setArrowsInBody(int, boolean)
. This method previously firedArrowBodyCountChangeEvent
so if you want to retain exact functionality, passtrue
forfireEvent
.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 anymoreMushroom 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 valueUsePlayer.resetIdleDuration()
insteadMagic valuesuppressLightUpdates is not functional in versions greater than 1.19.4UsePlayer.sendDeathScreen(net.kyori.adventure.text.Component)
instead, as 1.20 removed the killer ID from the packet.usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
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.suppressLightUpdates is no longer available in 1.20+, usePlayer.sendMultiBlockChange(Map)
UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)UsePlayer.sendBlockUpdate(Location, TileState)
by creating a new virtualSign
block state viaBlockData.createBlockState()
(constructed e.g. viaMaterial.createBlockData()
)Minecraft no longer uses textures packs. Instead you should usePlayer.setResourcePack(UUID, String, byte[], net.kyori.adventure.text.Component, boolean)
.usePlayer.getPing()
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
does not do anythingdoes not do anythingin favour ofTextDisplay.text()
in favour ofTextDisplay.text(net.kyori.adventure.text.Component)
replaced byEntity.getOrigin()
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 betterDuplicate api, useWither.getInvulnerableTicks()
Duplicate api, useWither.setInvulnerableTicks(int)
seeAgeable.setBaby()
andAgeable.setAdult()
check if instanceofZombieVillager
.seeAgeable.setBaby()
andAgeable.setAdult()
must spawnZombieVillager
.slime blocks make the value of this method inaccurate due to blocks being pushed at the sidenot 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 methodThis 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()
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 fromPlayerPreLoginEvent
This method uses a deprecated enum fromPlayerPreLoginEvent
in favour ofAsyncPlayerPreLoginEvent.kickMessage()
This method uses a deprecated enum fromPlayerPreLoginEvent
This method uses a deprecated enum fromPlayerPreLoginEvent
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.This method is provided for backward compatibility with no guarantee to the effect of viewing or modifying the set.books 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 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()
No effectNo effectin favour ofPlayerPreLoginEvent.kickMessage()
in favour ofPlayerQuitEvent.quitMessage()
Hash does not seem to ever be setdismounting on tp is no longer controlled by the serverin favour ofBroadcastMessageEvent.message()
in favour ofServerListPingEvent.motd()
chat previews have been removedUseRegistry.get(NamespacedKey)
instead.useIterable.iterator()
.biomes are now 3-dimensionalbiomes are now 3-dimensionalUses magic valuesChunkGenerator.ChunkData
are now directly providedThe generation is now split up and the new methods should be used, seeChunkGenerator
the chunk generation code should be thread safehas no effect, bedrock generation is part of the surface step, seeChunkGenerator.shouldGenerateSurface()
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 insteadMagic valuein favour ofInventoryView.title()
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.ItemStack
implementsTranslatable
; use that andComponent.translatable(net.kyori.adventure.translation.Translatable)
instead.cast toBlockDataMeta
and useBlockDataMeta.getBlockData(Material)
ItemStack
implementsTranslatable
; use that andComponent.translatable(net.kyori.adventure.translation.Translatable)
instead.in 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 thePersistentDataHolder
API. Please usePersistentDataHolder.getPersistentDataContainer()
instead of this.in favour ofItemMeta.displayName()
UseItemMeta.displayName()
and cast it to aTranslatableComponent
. No longer used by the client.in favour ofItemMeta.lore()
useItemMeta.lore()
UseItemMeta.displayName()
and check if it is instanceof aTranslatableComponent
.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 replacementUseItemMeta.displayName(Component)
with aTranslatableComponent
. No longer used by the client.in favour ofItemMeta.lore(List)
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 ownPotionType
usePotionMeta.getBasePotionType()
instead.Upgraded / extended potions are now their ownPotionType
usePotionMeta.setBasePotionType(org.bukkit.potion.PotionType)
instead.different types are different itemsdifferent types are different itemsuseRegistry.getKey(Keyed)
andRegistry.TRIM_MATERIAL
. TrimMaterials can exist without a key.useRegistry.getKey(Keyed)
andRegistry.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.only encodes y block ranges from -512 to 511 and represents an already changed implementation detailMagic value, useMapCanvas.setPixelColor(int, int, Color)
in favour ofMapCursor.caption()
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 valueThis 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)
instead.useIterable.iterator()
.in favour ofNameable.customName()
should never be used by plugins, for internal use only!!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.not an API methodnot an API methodMay be inaccurate due to different plugin implementations.unusedNon-functionalNon-functionalUpgraded / extended potions are now their ownPotionType
usePotionType.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()
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 aNamespacedKey
object 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)
usesendMessage
methods that acceptComponent
usesendMessage
methods that acceptComponent
The new multi-stage worldgen API allows a similar effect by overriding all of the "shouldGenerate..." methods to return true, and then modifying the chunkdata in a later stage such as surface or bedrock generation.Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)
Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)
Deprecated in favor ofServer.getSpawnLimit(SpawnCategory)
in favour ofServer.motd()
in 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 removedlook for atranslationKey()
method insteadMagic valueMagic valueunused as of 1.19this method does not handle tile 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)
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, useRegionAccessor.getHighestBlockYAt(int, int, HeightMap)
Upstream has added support for this, useRegionAccessor.getHighestBlockYAt(Location, HeightMap)
biomes are now 3-dimensionalDeprecated in favor ofWorld.getSpawnLimit(SpawnCategory)
biomes 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.Deprecated in favor ofWorld.setSpawnLimit(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.setTicksPerSpawns(SpawnCategory, int)
Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)
Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)
Deprecated in favor ofWorld.setSpawnLimit(SpawnCategory, int)
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)
Magic value. 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 removeduseWorldBorder.isInside(Location)
for an upstream compatible replacement
-
ConstructorDescriptionUse 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,SmithingTransformRecipe
andSmithingTrimRecipe
. 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 valueIn favour of usingPotion(PotionType)
withPotion.splash()
.
-
Enum ConstantDescriptiondeprecated in favor of
BanList.Type.PROFILE
no longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsno longer existsthis target no longer exists in Vanillasplit into individual effectssplit into individual effectsno longer called, chunks are generated with entities already existing. Consider usingChunkLoadEvent
,ChunkLoadEvent.isNewChunk()
andChunk.getEntities()
for similar effect.misleading name and description, useItemFlag.HIDE_ITEM_SPECIFICS
MaterialData
is deprecated APIMaterialData
is deprecated APIMaterialData
is deprecated APIall plugins are now assumed to be UTF-8 aware.