1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-30 08:09:01 +01:00
PaperMC/patches/api/0260-More-World-API.patch
Spottedleaf 8c5b837e05 Rework async chunk api implementation
Firstly, the old methods all routed to the CompletableFuture method.
However, the CF method could not guarantee that if the caller
was off-main that the future would be "completed" on-main. Since
the callback methods used the CF one, this meant that the callback
methods did not guarantee that the callbacks were to be called on
the main thread.

Now, all methods route to getChunkAtAsync(x, z, gen, urgent, cb)
so that the methods with the callback are guaranteed to invoke
the callback on the main thread. The CF behavior remains unchanged;
it may still appear to complete on main if invoked off-main.

Secondly, remove the scheduleOnMain invocation in the async
chunk completion. This unnecessarily delays the callback
by 1 tick.

Thirdly, add getChunksAtAsync(minX, minZ, maxX, maxZ, ...) which
will load chunks within an area. This method is provided as a helper
as keeping all chunks loaded within an area can be complicated to
implement for plugins (due to the lacking ticket API), and is
already implemented internally anyways.

Fourthly, remove the ticket addition that occured with getChunkAt
and getChunkAtAsync. The ticket addition may delay the unloading
of the chunk unnecessarily. It also fixes a very rare timing bug
where the future/callback would be completed after the chunk
unloads.
2024-11-18 23:00:59 -08:00

83 lines
3.2 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Tue, 7 Jul 2020 10:53:22 -0700
Subject: [PATCH] More World API
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
index 7ef12976430272d814374ee066e975457111b7f3..b22530070b95667e2b548ef1e68e536a5b8ee138 100644
--- a/src/main/java/org/bukkit/World.java
+++ b/src/main/java/org/bukkit/World.java
@@ -3848,6 +3848,72 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
@Nullable
StructureSearchResult locateNearestStructure(@NotNull Location origin, @NotNull Structure structure, int radius, boolean findUnexplored);
+ // Paper start
+ /**
+ * Locates the nearest biome based on an origin, biome type, and radius to search.
+ * Step defaults to {@code 8}.
+ *
+ * @param origin Origin location
+ * @param biome Biome to find
+ * @param radius radius to search
+ * @return Location of biome or null if not found in specified radius
+ * @deprecated use {@link #locateNearestBiome(Location, int, Biome...)}
+ */
+ @Deprecated
+ @Nullable
+ default Location locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius) {
+ return java.util.Optional.ofNullable(this.locateNearestBiome(origin, radius, 8, 8, biome)).map(BiomeSearchResult::getLocation).orElse(null);
+ }
+
+ /**
+ * Locates the nearest biome based on an origin, biome type, and radius to search
+ * and step
+ *
+ * @param origin Origin location
+ * @param biome Biome to find
+ * @param radius radius to search
+ * @param step Search step 1 would mean checking every block, 8 would be every 8th block
+ * @return Location of biome or null if not found in specified radius
+ * @deprecated use {@link #locateNearestBiome(Location, int, int, int, Biome...)}
+ */
+ @Deprecated
+ @Nullable
+ default Location locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius, int step) {
+ return java.util.Optional.ofNullable(this.locateNearestBiome(origin, radius, step, step, biome)).map(BiomeSearchResult::getLocation).orElse(null);
+ }
+
+ /**
+ * Gets the coordinate scaling of this world.
+ *
+ * @return the coordinate scale
+ */
+ double getCoordinateScale();
+
+ /**
+ * Checks if this world has a fixed time
+ *
+ * @return whether this world has fixed time
+ */
+ boolean isFixedTime();
+
+ /**
+ * Gets the collection of materials that burn infinitely in this world.
+ *
+ * @return the materials that will forever stay lit by fire
+ */
+ @NotNull
+ Collection<Material> getInfiniburn();
+
+ /**
+ * Posts a specified game event at a location
+ *
+ * @param sourceEntity optional source entity
+ * @param gameEvent the game event to post
+ * @param position the position in the world where to post the event to listeners
+ */
+ void sendGameEvent(@Nullable Entity sourceEntity, @NotNull GameEvent gameEvent, @NotNull Vector position);
+ // Paper end
+
// Spigot start
@Deprecated(forRemoval = true) // Paper
public class Spigot {