Update a whole lot of deprecated annotations

2025-03-21 17:50:04 +01:00
parent bb1beda67b
commit 9f00461456
113 changed files with 785 additions and 710 deletions
@@ -20,9 +20,9 @@ public interface AbstractArrow extends Projectile {
     *
     * @return the knockback strength value
     * @see #getWeapon()
-     * @deprecated a function of the firing weapon
+     * @deprecated moved to being a function of the firing weapon, always returns 0 here
     */
-    @Deprecated(since = "1.21")
+    @Deprecated(since = "1.21", forRemoval = true)
    public int getKnockbackStrength();

    /**
@@ -30,9 +30,9 @@ public interface AbstractArrow extends Projectile {
     *
     * @param knockbackStrength the knockback strength value
     * @see #setWeapon(org.bukkit.inventory.ItemStack)
-     * @deprecated a function of the firing weapon
+     * @deprecated moved to being a function of the firing weapon, does nothing here
     */
-    @Deprecated(since = "1.21")
+    @Deprecated(since = "1.21", forRemoval = true)
    public void setKnockbackStrength(int knockbackStrength);

    /**
@@ -145,9 +145,9 @@ public interface AbstractArrow extends Projectile {
     *
     * @param shotFromCrossbow if shot from a crossbow
     * @see #setWeapon(org.bukkit.inventory.ItemStack)
-     * @deprecated a function of the firing weapon instead
+     * @deprecated a function of the firing weapon instead, this method does nothing
     */
-    @Deprecated(since = "1.21")
+    @Deprecated(since = "1.21", forRemoval = true)
    public void setShotFromCrossbow(boolean shotFromCrossbow);

    /**
@@ -20,7 +20,7 @@ public interface AbstractHorse extends Vehicle, InventoryHolder, Tameable {
     * @return a {@link Horse.Variant} representing the horse's variant
     * @deprecated different variants are different classes
     */
-    @Deprecated(since = "1.11")
+    @Deprecated(since = "1.11", forRemoval = true)
    @NotNull
    public Horse.Variant getVariant();

@@ -28,7 +28,7 @@ public interface AbstractHorse extends Vehicle, InventoryHolder, Tameable {
     * @param variant variant
     * @deprecated you are required to spawn a different entity
     */
-    @Deprecated(since = "1.11")
+    @Deprecated(since = "1.11", forRemoval = true)
    @Contract("_ -> fail")
    public void setVariant(Horse.Variant variant);

@@ -108,7 +108,7 @@ public interface AbstractHorse extends Vehicle, InventoryHolder, Tameable {
     * @return true if eating hay
     * @deprecated use {@link #isEatingGrass()}, this name is incorrect
     */
-    @Deprecated // Paper - Horse API
+    @Deprecated(forRemoval = true)
    boolean isEatingHaystack();

    /**
@@ -117,7 +117,7 @@ public interface AbstractHorse extends Vehicle, InventoryHolder, Tameable {
     * @param eatingHaystack new hay grazing status
     * @deprecated use {@link #setEatingGrass(boolean)}, this name is incorrect
     */
-    @Deprecated // Paper - Horse API
+    @Deprecated(forRemoval = true)
    void setEatingHaystack(boolean eatingHaystack);

    @NotNull
@@ -21,7 +21,7 @@ public interface AbstractSkeleton extends Monster, com.destroystokyo.paper.entit
     * @return Current type
     * @deprecated should check what class instance this is.
     */
-    @Deprecated(since = "1.17")
+    @Deprecated(since = "1.17", forRemoval = true)
    @NotNull
    public Skeleton.SkeletonType getSkeletonType();

@@ -29,7 +29,7 @@ public interface AbstractSkeleton extends Monster, com.destroystokyo.paper.entit
     * @param type type
     * @deprecated Must spawn a new subtype variant
     */
-    @Deprecated(since = "1.17")
+    @Deprecated(since = "1.17", forRemoval = true)
    @Contract("_ -> fail")
    public void setSkeletonType(Skeleton.SkeletonType type);

@@ -152,7 +152,7 @@ public interface AreaEffectCloud extends Entity {
     * @param data PotionData to set the base potion state to
     * @deprecated Upgraded / extended potions are now their own {@link PotionType} use {@link #setBasePotionType} instead.
     */
-    @Deprecated(since = "1.20.6")
+    @Deprecated(since = "1.20.6", forRemoval = true)
    void setBasePotionData(@Nullable PotionData data);

    /**
@@ -162,7 +162,7 @@ public interface AreaEffectCloud extends Entity {
     * @deprecated Upgraded / extended potions are now their own {@link PotionType} use {@link #getBasePotionType()} instead.
     */
    @Nullable
-    @Deprecated(since = "1.20.6")
+    @Deprecated(since = "1.20.6", forRemoval = true)
    PotionData getBasePotionData();

    /**
@@ -17,7 +17,7 @@ public interface Arrow extends AbstractArrow {
     * @param data PotionData to set the base potion state to
     * @deprecated Upgraded / extended potions are now their own {@link PotionType} use {@link #setBasePotionType} instead.
     */
-    @Deprecated(since = "1.20.6")
+    @Deprecated(since = "1.20.6", forRemoval = true)
    void setBasePotionData(@Nullable PotionData data);

    /**
@@ -27,7 +27,7 @@ public interface Arrow extends AbstractArrow {
     * @deprecated Upgraded / extended potions are now their own {@link PotionType} use {@link #getBasePotionType()} instead.
     */
    @Nullable
-    @Deprecated(since = "1.20.6")
+    @Deprecated(since = "1.20.6", forRemoval = true)
    PotionData getBasePotionData();

    /**
@@ -15,7 +15,7 @@ public interface Boat extends Vehicle, io.papermc.paper.entity.Leashable { // Pa
     * @return the wood type
     * @deprecated deprecated in favor of {@link #getBoatType()}
     */
-    @Deprecated(since = "1.19")
+    @Deprecated(since = "1.19", forRemoval = true)
    @NotNull
    TreeSpecies getWoodType();

@@ -25,7 +25,7 @@ public interface Boat extends Vehicle, io.papermc.paper.entity.Leashable { // Pa
     * @param species the new wood type
     * @deprecated deprecated in favor of {@link #setBoatType(Type)}
     */
-    @Deprecated(since = "1.19")
+    @Deprecated(since = "1.19", forRemoval = true)
    void setWoodType(@NotNull TreeSpecies species);

    /**
@@ -10,7 +10,7 @@ public interface Endermite extends Monster {
     * @return player spawned status
     * @deprecated this functionality no longer exists
     */
-    @Deprecated(since = "1.17")
+    @Deprecated(since = "1.17", forRemoval = true)
    boolean isPlayerSpawned();

    /**
@@ -21,7 +21,7 @@ public interface Endermite extends Monster {
     * @param playerSpawned player spawned status
     * @deprecated this functionality no longer exists
     */
-    @Deprecated(since = "1.17")
+    @Deprecated(since = "1.17", forRemoval = true)
    void setPlayerSpawned(boolean playerSpawned);
    // Paper start
    /**
@@ -407,7 +407,7 @@ public enum EntityType implements Keyed, Translatable, net.kyori.adventure.trans
     * @return the raw type id
     * @deprecated Magic value
     */
-    @Deprecated(since = "1.6.2")
+    @Deprecated(since = "1.6.2", forRemoval = true)
    public short getTypeId() {
        return typeId;
    }
@@ -436,7 +436,7 @@ public enum EntityType implements Keyed, Translatable, net.kyori.adventure.trans
     * @return the matching entity type or null
     * @deprecated Magic value
     */
-    @Deprecated(since = "1.6.2")
+    @Deprecated(since = "1.6.2", forRemoval = true)
    @Nullable
    public static EntityType fromId(int id) {
        if (id > Short.MAX_VALUE) {
@@ -208,7 +208,7 @@ public interface FishHook extends Projectile {
     * @return chance the bite chance
     * @deprecated has no effect in newer Minecraft versions
     */
-    @Deprecated(since = "1.9.2")
+    @Deprecated(since = "1.9.2", forRemoval = true)
    public double getBiteChance();

    /**
@@ -222,7 +222,7 @@ public interface FishHook extends Projectile {
     *     and 1
     * @deprecated has no effect in newer Minecraft versions
     */
-    @Deprecated(since = "1.9.2")
+    @Deprecated(since = "1.9.2", forRemoval = true)
    public void setBiteChance(double chance) throws IllegalArgumentException;

    /**
@@ -154,14 +154,14 @@ public interface Horse extends AbstractHorse {
     * @return carrying chest status
     * @deprecated see {@link ChestedHorse}
     */
-    @Deprecated(since = "1.11")
+    @Deprecated(since = "1.11", forRemoval = true)
    public boolean isCarryingChest();

    /**
     * @param chest chest
     * @deprecated see {@link ChestedHorse}
     */
-    @Deprecated(since = "1.11")
+    @Deprecated(since = "1.11", forRemoval = true)
    public void setCarryingChest(boolean chest);

    @NotNull
@@ -91,7 +91,7 @@ public interface LightningStrike extends Entity {
    /**
     * @deprecated Unsupported api
     */
-    @Deprecated // Paper
+    @Deprecated(forRemoval = true)
    public class Spigot extends Entity.Spigot {

        /**
@@ -100,7 +100,7 @@ public interface LightningStrike extends Entity {
         * @return whether the strike is silent.
         * @deprecated sound is now client side and cannot be removed
         */
-        @Deprecated(since = "1.20.4")
+        @Deprecated(since = "1.20.4", forRemoval = true)
        public boolean isSilent() {
            throw new UnsupportedOperationException("Not supported yet.");
        }
@@ -111,7 +111,7 @@ public interface LightningStrike extends Entity {
     */
    @NotNull
    @Override
-    @Deprecated // Paper
+    @Deprecated(forRemoval = true)
    Spigot spigot();
    // Spigot end

@@ -73,7 +73,7 @@ public interface Ocelot extends Animals {
         * @return Type ID.
         * @deprecated Magic value
         */
-        @Deprecated(since = "1.6.2")
+        @Deprecated(since = "1.6.2", forRemoval = true)
        public int getId() {
            return id;
        }
@@ -85,7 +85,7 @@ public interface Ocelot extends Animals {
         * @return Resulting type, or null if not found.
         * @deprecated Magic value
         */
-        @Deprecated(since = "1.6.2")
+        @Deprecated(since = "1.6.2", forRemoval = true)
        @Nullable
        public static Type getType(int id) {
            return (id >= types.length) ? null : types[id];
@@ -32,14 +32,14 @@ public interface Zombie extends Monster, Ageable {
     * @return Whether the zombie is a villager
     * @deprecated check if instanceof {@link ZombieVillager}.
     */
-    @Deprecated(since = "1.10.2")
+    @Deprecated(since = "1.10.2", forRemoval = true)
    public boolean isVillager();

    /**
     * @param flag flag
     * @deprecated must spawn {@link ZombieVillager}.
     */
-    @Deprecated(since = "1.9")
+    @Deprecated(since = "1.9", forRemoval = true)
    @Contract("_ -> fail")
    public void setVillager(boolean flag);

@@ -47,7 +47,7 @@ public interface Zombie extends Monster, Ageable {
     * @param profession profession
     * @see ZombieVillager#getVillagerProfession()
     */
-    @Deprecated(since = "1.10.2")
+    @Deprecated(since = "1.10.2", forRemoval = true)
    @Contract("_ -> fail")
    public void setVillagerProfession(Villager.Profession profession);

@@ -55,7 +55,7 @@ public interface Zombie extends Monster, Ageable {
     * @return profession
     * @see ZombieVillager#getVillagerProfession()
     */
-    @Deprecated(since = "1.10.2")
+    @Deprecated(since = "1.10.2", forRemoval = true)
    @Nullable
    @Contract("-> null")
    public Villager.Profession getVillagerProfession();