Send biome updates for chunks when possible (#2443)

me4502 · web-flow · commit 1a12db4fbcb8 · 2023-12-06T21:39:06.000+10:00
* Send biome updates [WIP]

* Add other platforms

* Ensure that the iterable won't be iterated twice
diff --git a/worldedit-bukkit/adapters/adapter-1.19.4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_19_R3/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.19.4/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_19_R3/PaperweightAdapter.java
@@ -23,6 +23,7 @@
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.common.util.concurrent.Futures;
 import com.mojang.datafixers.util.Either;
@@ -174,6 +175,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -969,6 +971,17 @@ public boolean generateStructure(StructureType type, World world, EditSession se
         }
     }
 
+    @Override
+    public void sendBiomeUpdates(World world, Iterable<BlockVector2> chunks) {
+        ServerLevel originalWorld = ((CraftWorld) world).getHandle();
+
+        List<ChunkAccess> nativeChunks = chunks instanceof Collection<BlockVector2> chunkCollection ? Lists.newArrayListWithCapacity(chunkCollection.size()) : Lists.newArrayList();
+        for (BlockVector2 chunk : chunks) {
+            nativeChunks.add(originalWorld.getChunk(chunk.getBlockX(), chunk.getBlockZ(), ChunkStatus.BIOMES, false));
+        }
+        originalWorld.getChunkSource().chunkMap.resendBiomesForChunks(nativeChunks);
+    }
+
     // ------------------------------------------------------------------------
     // Code that is less likely to break
     // ------------------------------------------------------------------------
diff --git a/worldedit-bukkit/adapters/adapter-1.20.2/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_20_R2/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.20.2/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_20_R2/PaperweightAdapter.java
@@ -23,6 +23,7 @@
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.common.util.concurrent.Futures;
 import com.mojang.datafixers.util.Either;
@@ -174,6 +175,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -970,6 +972,17 @@ public boolean generateStructure(StructureType type, World world, EditSession se
         }
     }
 
+    @Override
+    public void sendBiomeUpdates(World world, Iterable<BlockVector2> chunks) {
+        ServerLevel originalWorld = ((CraftWorld) world).getHandle();
+
+        List<ChunkAccess> nativeChunks = chunks instanceof Collection<BlockVector2> chunkCollection ? Lists.newArrayListWithCapacity(chunkCollection.size()) : Lists.newArrayList();
+        for (BlockVector2 chunk : chunks) {
+            nativeChunks.add(originalWorld.getChunk(chunk.getBlockX(), chunk.getBlockZ(), ChunkStatus.BIOMES, false));
+        }
+        originalWorld.getChunkSource().chunkMap.resendBiomesForChunks(nativeChunks);
+    }
+
     // ------------------------------------------------------------------------
     // Code that is less likely to break
     // ------------------------------------------------------------------------
diff --git a/worldedit-bukkit/adapters/adapter-1.20/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_20_R1/PaperweightAdapter.java b/worldedit-bukkit/adapters/adapter-1.20/src/main/java/com/sk89q/worldedit/bukkit/adapter/impl/v1_20_R1/PaperweightAdapter.java
@@ -23,6 +23,7 @@
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.common.util.concurrent.Futures;
 import com.mojang.datafixers.util.Either;
@@ -174,6 +175,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -970,6 +972,17 @@ public boolean generateStructure(StructureType type, World world, EditSession se
         }
     }
 
+    @Override
+    public void sendBiomeUpdates(World world, Iterable<BlockVector2> chunks) {
+        ServerLevel originalWorld = ((CraftWorld) world).getHandle();
+
+        List<ChunkAccess> nativeChunks = chunks instanceof Collection<BlockVector2> chunkCollection ? Lists.newArrayListWithCapacity(chunkCollection.size()) : Lists.newArrayList();
+        for (BlockVector2 chunk : chunks) {
+            nativeChunks.add(originalWorld.getChunk(chunk.getBlockX(), chunk.getBlockZ(), ChunkStatus.BIOMES, false));
+        }
+        originalWorld.getChunkSource().chunkMap.resendBiomesForChunks(nativeChunks);
+    }
+
     // ------------------------------------------------------------------------
     // Code that is less likely to break
     // ------------------------------------------------------------------------
diff --git a/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/BukkitWorld.java b/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/BukkitWorld.java
@@ -329,6 +329,14 @@ public void fixAfterFastMode(Iterable<BlockVector2> chunks) {
         }
     }
 
+    @Override
+    public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
+        BukkitImplAdapter adapter = WorldEditPlugin.getInstance().getBukkitImplAdapter();
+        if (adapter != null) {
+            adapter.sendBiomeUpdates(getWorld(), chunks);
+        }
+    }
+
     @Override
     public boolean playEffect(Vector3 position, int type, int data) {
         World world = getWorld();
diff --git a/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/adapter/BukkitImplAdapter.java b/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/adapter/BukkitImplAdapter.java
@@ -25,6 +25,7 @@
 import com.sk89q.worldedit.entity.BaseEntity;
 import com.sk89q.worldedit.extent.Extent;
 import com.sk89q.worldedit.internal.wna.WorldNativeAccess;
+import com.sk89q.worldedit.math.BlockVector2;
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.regions.Region;
 import com.sk89q.worldedit.registry.state.Property;
@@ -314,4 +315,17 @@ default boolean generateStructure(StructureType feature, World world, EditSessio
     default void initializeRegistries() {
 
     }
+
+    /**
+     * Sends biome updates for the given chunks.
+     *
+     * <p>This doesn't modify biomes at all, it just sends the current state of the biomes
+     * in the world to all of the nearby players, updating the visual representation of the
+     * biomes on their clients.</p>
+     *
+     * @param world the world
+     * @param chunks a list of chunk coordinates to send biome updates for
+     */
+    default void sendBiomeUpdates(World world, Iterable<BlockVector2> chunks) {
+    }
 }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extent/world/SideEffectExtent.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extent/world/SideEffectExtent.java
@@ -29,6 +29,7 @@
 import com.sk89q.worldedit.util.SideEffectSet;
 import com.sk89q.worldedit.util.collection.BlockMap;
 import com.sk89q.worldedit.world.World;
+import com.sk89q.worldedit.world.biome.BiomeType;
 import com.sk89q.worldedit.world.block.BlockState;
 import com.sk89q.worldedit.world.block.BlockStateHolder;
 
@@ -50,6 +51,7 @@ public class SideEffectExtent extends AbstractDelegateExtent {
     private final World world;
     private final Map<BlockVector3, BlockState> positions = BlockMap.create();
     private final Set<BlockVector2> dirtyChunks = new HashSet<>();
+    private final Set<BlockVector2> dirtyBiomes = new HashSet<>();
     private SideEffectSet sideEffectSet = SideEffectSet.defaults();
     private boolean postEditSimulation;
 
@@ -97,8 +99,14 @@ public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location, B
         return world.setBlock(location, block, postEditSimulation ? INTERNAL_NONE : sideEffectSet);
     }
 
+    @Override
+    public boolean setBiome(BlockVector3 position, BiomeType biome) {
+        dirtyBiomes.add(BlockVector2.at(position.getBlockX() >> 4, position.getBlockZ() >> 4));
+        return world.setBiome(position, biome);
+    }
+
     public boolean commitRequired() {
-        return postEditSimulation || !dirtyChunks.isEmpty();
+        return postEditSimulation || !dirtyChunks.isEmpty() || !dirtyBiomes.isEmpty();
     }
 
     @Override
@@ -113,6 +121,10 @@ public Operation resume(RunContext run) throws WorldEditException {
                     world.fixAfterFastMode(dirtyChunks);
                 }
 
+                if (!dirtyBiomes.isEmpty()) {
+                    world.sendBiomeUpdates(dirtyBiomes);
+                }
+
                 if (postEditSimulation) {
                     Iterator<Map.Entry<BlockVector3, BlockState>> positionIterator = positions.entrySet().iterator();
                     while (run.shouldContinue() && positionIterator.hasNext()) {
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/AbstractWorld.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/AbstractWorld.java
@@ -94,6 +94,10 @@ public void checkLoadedChunk(BlockVector3 pt) {
     public void fixAfterFastMode(Iterable<BlockVector2> chunks) {
     }
 
+    @Override
+    public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
+    }
+
     @Override
     public void fixLighting(Iterable<BlockVector2> chunks) {
     }
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/World.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/World.java
@@ -311,6 +311,17 @@ default boolean generateFeature(ConfiguredFeatureType type, EditSession editSess
      */
     void fixAfterFastMode(Iterable<BlockVector2> chunks);
 
+    /**
+     * Sends biome updates for the given chunks.
+     *
+     * <p>This doesn't modify biomes at all, it just sends the current state of the biomes
+     * in the world to all of the nearby players, updating the visual representation of the
+     * biomes on their clients.</p>
+     *
+     * @param chunks a list of chunk coordinates to send biome updates for
+     */
+    void sendBiomeUpdates(Iterable<BlockVector2> chunks);
+
     /**
      * Relight the given chunks if possible.
      *
diff --git a/worldedit-fabric/src/main/java/com/sk89q/worldedit/fabric/FabricWorld.java b/worldedit-fabric/src/main/java/com/sk89q/worldedit/fabric/FabricWorld.java
@@ -23,6 +23,7 @@
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.common.collect.Streams;
 import com.google.common.util.concurrent.Futures;
@@ -115,6 +116,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -526,6 +528,15 @@ public void fixAfterFastMode(Iterable<BlockVector2> chunks) {
         fixLighting(chunks);
     }
 
+    @Override
+    public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
+        List<ChunkAccess> nativeChunks = chunks instanceof Collection<BlockVector2> chunkCollection ? Lists.newArrayListWithCapacity(chunkCollection.size()) : Lists.newArrayList();
+        for (BlockVector2 chunk : chunks) {
+            nativeChunks.add(getWorld().getChunk(chunk.getBlockX(), chunk.getBlockZ(), ChunkStatus.BIOMES, false));
+        }
+        ((ServerLevel) getWorld()).getChunkSource().chunkMap.resendBiomesForChunks(nativeChunks);
+    }
+
     @Override
     public void fixLighting(Iterable<BlockVector2> chunks) {
         Level world = getWorld();
diff --git a/worldedit-forge/src/main/java/com/sk89q/worldedit/forge/ForgeWorld.java b/worldedit-forge/src/main/java/com/sk89q/worldedit/forge/ForgeWorld.java
@@ -23,6 +23,7 @@
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.common.collect.Streams;
 import com.google.common.util.concurrent.Futures;
@@ -113,6 +114,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -508,6 +510,15 @@ public void fixAfterFastMode(Iterable<BlockVector2> chunks) {
         fixLighting(chunks);
     }
 
+    @Override
+    public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {
+        List<ChunkAccess> nativeChunks = chunks instanceof Collection<BlockVector2> chunkCollection ? Lists.newArrayListWithCapacity(chunkCollection.size()) : Lists.newArrayList();
+        for (BlockVector2 chunk : chunks) {
+            nativeChunks.add(getWorld().getChunk(chunk.getBlockX(), chunk.getBlockZ(), ChunkStatus.BIOMES, false));
+        }
+        ((ServerLevel) getWorld()).getChunkSource().chunkMap.resendBiomesForChunks(nativeChunks);
+    }
+
     @Override
     public void fixLighting(Iterable<BlockVector2> chunks) {
         ServerLevel world = getWorld();

Original file line number	Diff line number	Diff line change
`@@ -329,6 +329,14 @@ public void fixAfterFastMode(Iterable<BlockVector2> chunks) {`
`329`	`329`	`}`
`330`	`330`	`}`
`331`	`331`
	`332`	`+ @Override`
	`333`	`+ public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {`
	`334`	`+ BukkitImplAdapter adapter = WorldEditPlugin.getInstance().getBukkitImplAdapter();`
	`335`	`+ if (adapter != null) {`
	`336`	`+ adapter.sendBiomeUpdates(getWorld(), chunks);`
	`337`	`+ }`
	`338`	`+ }`
	`339`	`+`
`332`	`340`	`@Override`
`333`	`341`	`public boolean playEffect(Vector3 position, int type, int data) {`
`334`	`342`	`World world = getWorld();`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,10 @@ public void checkLoadedChunk(BlockVector3 pt) {`
`94`	`94`	`public void fixAfterFastMode(Iterable<BlockVector2> chunks) {`
`95`	`95`	`}`
`96`	`96`
	`97`	`+ @Override`
	`98`	`+ public void sendBiomeUpdates(Iterable<BlockVector2> chunks) {`
	`99`	`+ }`
	`100`	`+`
`97`	`101`	`@Override`
`98`	`102`	`public void fixLighting(Iterable<BlockVector2> chunks) {`
`99`	`103`	`}`