Deprecate playEffect without replacement (#2830)

Author: me4502

verification/src/changes/accepted-fabric-public-api-changes.json

@@ -7,5 +7,14 @@
         "CONSTRUCTOR_REMOVED"
       ]
     }
+  ],
+  "Removal of override": [
+    {
+      "type": "com.sk89q.worldedit.fabric.FabricWorld",
+      "member": "Method com.sk89q.worldedit.fabric.FabricWorld.playEffect(com.sk89q.worldedit.math.Vector3,int,int)",
+      "changes": [
+        "METHOD_REMOVED"
+      ]
+    }
   ]
 }

worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/BukkitWorld.java

@@ -355,6 +355,7 @@ public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
         }
     }
 
+    @Deprecated
     @Override
     public boolean playEffect(Vector3 position, int type, int data) {
         World world = getWorld();

worldedit-core/src/main/java/com/sk89q/worldedit/command/tool/AreaPickaxe.java

@@ -52,6 +52,7 @@ public boolean canUse(Actor player) {
         return player.hasPermission("worldedit.superpickaxe.area");
     }
 
+    @SuppressWarnings("deprecation")
     @Override
     public boolean actPrimary(Platform server, LocalConfiguration config, Player player, LocalSession session, Location clicked, @Nullable Direction face) {
         World world = BlockTool.requireWorld(clicked);

worldedit-core/src/main/java/com/sk89q/worldedit/command/tool/RecursivePickaxe.java

@@ -86,6 +86,7 @@ public boolean actPrimary(Platform server, LocalConfiguration config, Player pla
         return true;
     }
 
+    @SuppressWarnings("deprecation")
     private static void recurse(Platform server, EditSession editSession, World world, BlockVector3 pos,
             BlockVector3 origin, double size, BlockType initialType, Set<BlockVector3> visited) throws MaxChangedBlocksException {
 

worldedit-core/src/main/java/com/sk89q/worldedit/world/AbstractWorld.java

@@ -46,6 +46,7 @@
  */
 public abstract class AbstractWorld implements World {
 
+    @Deprecated
     private final PriorityQueue<QueuedEffect> effectQueue = new PriorityQueue<>();
     private int taskId = -1;
 
@@ -102,11 +103,13 @@ public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
     public void fixLighting(Iterable<BlockVector2> chunks) {
     }
 
+    @Deprecated
     @Override
     public boolean playEffect(Vector3 position, int type, int data) {
         return false;
     }
 
+    @Deprecated
     @Override
     public boolean queueBlockBreakEffect(Platform server, BlockVector3 position, BlockType blockType, double priority) {
         if (taskId == -1) {
@@ -169,6 +172,7 @@ public boolean isValid() {
         return true;
     }
 
+    @Deprecated
     private class QueuedEffect implements Comparable<QueuedEffect> {
         private final Vector3 position;
         private final BlockType blockType;
@@ -180,7 +184,7 @@ private QueuedEffect(Vector3 position, BlockType blockType, double priority) {
             this.priority = priority;
         }
 
-        @SuppressWarnings("deprecation")
+        @Deprecated
         public void play() {
             playEffect(position, 2001, blockType.getLegacyId());
         }

worldedit-core/src/main/java/com/sk89q/worldedit/world/World.java

@@ -336,7 +336,9 @@ default boolean generateFeature(ConfiguredFeatureType type, EditSession editSess
      * @param type the effect type
      * @param data the effect data
      * @return true if the effect was played
+     * @deprecated This is deprecated without replacement.
      */
+    @Deprecated
     boolean playEffect(Vector3 position, int type, int data);
 
     /**
@@ -347,7 +349,9 @@ default boolean generateFeature(ConfiguredFeatureType type, EditSession editSess
      * @param blockType the block type
      * @param priority the priority
      * @return true if the effect was played
+     * @deprecated This is deprecated without replacement.
      */
+    @Deprecated
     boolean queueBlockBreakEffect(Platform server, BlockVector3 position, BlockType blockType, double priority);
 
     /**

worldedit-fabric/src/main/java/com/sk89q/worldedit/fabric/FabricWorld.java

@@ -575,13 +575,6 @@ public void fixLighting(Iterable<BlockVector2> chunks) {
         }
     }
 
-    @Override
-    public boolean playEffect(Vector3 position, int type, int data) {
-        // TODO update sound API
-        // getWorld().playSound(type, FabricAdapter.toBlockPos(position.toBlockPoint()), data);
-        return true;
-    }
-
     @Override
     public WeatherType getWeather() {
         LevelData info = getWorld().getLevelData();

worldedit-neoforge/src/main/java/com/sk89q/worldedit/neoforge/NeoForgeWorld.java

@@ -560,13 +560,6 @@ public void fixLighting(Iterable<BlockVector2> chunks) {
         }
     }
 
-    @Override
-    public boolean playEffect(Vector3 position, int type, int data) {
-        // TODO update sound API
-        // getWorld().play(type, NeoForgeAdapter.toBlockPos(position.toBlockPoint()), data);
-        return true;
-    }
-
     @Override
     public WeatherType getWeather() {
         LevelData info = getWorld().getLevelData();