Implement custom legacy biome

lynxplay · lynxplay · commit c7b227023706 · 2025-03-25T16:27:03.000+01:00
Also move wrongly registered moonrise ticket type to the vanilla type.
diff --git a/paper-api/src/main/java/io/papermc/paper/InternalAPIBridge.java b/paper-api/src/main/java/io/papermc/paper/InternalAPIBridge.java
@@ -1,6 +1,7 @@
 package io.papermc.paper;
 
 import net.kyori.adventure.util.Services;
+import org.bukkit.block.Biome;
 import org.bukkit.damage.DamageEffect;
 import org.jetbrains.annotations.ApiStatus;
 import org.jspecify.annotations.NullMarked;
@@ -35,5 +36,14 @@ class Holder {
      * @return the damage effect.
      */
     DamageEffect getDamageEffect(String key);
+
+    /**
+     * Constructs the legacy custom biome instance for the biome enum.
+     *
+     * @return the created biome.
+     */
+    @Deprecated(forRemoval = true, since = "1.21.5")
+    @ApiStatus.ScheduledForRemoval(inVersion = "1.22")
+    Biome constructLegacyCustomBiome();
 }
 
diff --git a/paper-api/src/main/java/org/bukkit/UnsafeValues.java b/paper-api/src/main/java/org/bukkit/UnsafeValues.java
@@ -142,9 +142,6 @@ public interface UnsafeValues {
     @ApiStatus.Internal
     <B extends Keyed> B get(RegistryKey<B> registry, NamespacedKey key);
 
-    @ApiStatus.Internal
-    Biome getCustomBiome();
-
     // Paper start
     @Deprecated(forRemoval = true)
     boolean isSupportedApiVersion(String apiVersion);
diff --git a/paper-api/src/main/java/org/bukkit/block/Biome.java b/paper-api/src/main/java/org/bukkit/block/Biome.java
@@ -2,6 +2,7 @@
 
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Lists;
+import io.papermc.paper.InternalAPIBridge;
 import io.papermc.paper.registry.RegistryAccess;
 import io.papermc.paper.registry.RegistryKey;
 import java.util.Locale;
@@ -95,7 +96,7 @@ public interface Biome extends OldEnum<Biome>, Keyed, net.kyori.adventure.transl
      * @deprecated Biome is no longer an enum, custom biomes will have their own biome instance.
      */
     @Deprecated(since = "1.21.3", forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.22") // Paper - will be removed via asm-utils
-    Biome CUSTOM = Bukkit.getUnsafe().getCustomBiome();
+    Biome CUSTOM = InternalAPIBridge.get().constructLegacyCustomBiome();
 
     @NotNull
     private static Biome getBiome(@NotNull String key) {
diff --git a/paper-server/patches/sources/ca/spottedleaf/moonrise/paper/util/BaseChunkSystemHooks.java.patch b/paper-server/patches/sources/ca/spottedleaf/moonrise/paper/util/BaseChunkSystemHooks.java.patch
@@ -28,7 +28,7 @@
 +
 +    private static final Logger LOGGER = LogUtils.getLogger();
 +    private static final ChunkStep FULL_CHUNK_STEP = ChunkPyramid.GENERATION_PYRAMID.getStepTo(ChunkStatus.FULL);
-+    private static final TicketType CHUNK_LOAD = TicketType.register("chunk_load", TicketType.NO_TIMEOUT, false, TicketType.TicketUse.LOADING);
++    private static final TicketType CHUNK_LOAD = TicketType.CHUNK_LOAD;
 +
 +    private long chunkLoadCounter = 0L;
 +
diff --git a/paper-server/patches/sources/net/minecraft/server/level/Ticket.java.patch b/paper-server/patches/sources/net/minecraft/server/level/Ticket.java.patch
@@ -1,10 +1,16 @@
 --- a/net/minecraft/server/level/Ticket.java
 +++ b/net/minecraft/server/level/Ticket.java
-@@ -19,6 +_,7 @@
-     private final TicketType type;
-     private final int ticketLevel;
-     private long ticksLeft;
+@@ -66,4 +_,13 @@
+     public boolean isTimedOut() {
+         return this.type.hasTimeout() && this.ticksLeft < 0L;
+     }
++
++    // Paper start - plugin chunk tickets
 +    public org.bukkit.plugin.@org.jspecify.annotations.Nullable Plugin key;
- 
-     public Ticket(TicketType type, int ticketLevel) {
-         this(type, ticketLevel, type.timeout());
++    public Ticket withPluginRef(org.bukkit.plugin.Plugin plugin) {
++        com.google.common.base.Preconditions.checkState(this.type == net.minecraft.server.level.TicketType.PLUGIN_TICKET);
++        this.key = plugin;
++        return this;
++    }
++    // Paper end - plugin chunk tickets
+ }
diff --git a/paper-server/patches/sources/net/minecraft/server/level/TicketType.java.patch b/paper-server/patches/sources/net/minecraft/server/level/TicketType.java.patch
@@ -1,13 +1,14 @@
 --- a/net/minecraft/server/level/TicketType.java
 +++ b/net/minecraft/server/level/TicketType.java
-@@ -13,11 +_,23 @@
+@@ -13,11 +_,24 @@
      public static final TicketType PORTAL = register("portal", 300L, true, TicketType.TicketUse.LOADING_AND_SIMULATION);
      public static final TicketType ENDER_PEARL = register("ender_pearl", 40L, false, TicketType.TicketUse.LOADING_AND_SIMULATION);
      public static final TicketType UNKNOWN = register("unknown", 1L, false, TicketType.TicketUse.LOADING);
 +    public static final TicketType PLUGIN = register("plugin", 0L, false, TicketType.TicketUse.LOADING_AND_SIMULATION); // CraftBukkit
 +    public static final TicketType POST_TELEPORT = register("post_teleport", 5L, false, TicketType.TicketUse.LOADING_AND_SIMULATION); // Paper
 +    public static final TicketType PLUGIN_TICKET = register("plugin_ticket", 0L, false, TicketType.TicketUse.LOADING_AND_SIMULATION); // Paper
 +    public static final TicketType FUTURE_AWAIT = register("future_await", 0L, false, TicketType.TicketUse.LOADING_AND_SIMULATION); // Paper
++    public static final TicketType CHUNK_LOAD = TicketType.register("chunk_load", TicketType.NO_TIMEOUT, false, TicketType.TicketUse.LOADING); // Paper - moonrise // TODO maybe move to moonrise
  
      public static TicketType register(String name, long timeout, boolean persist, TicketType.TicketUse use) {
          return Registry.register(BuiltInRegistries.TICKET_TYPE, name, new TicketType(timeout, persist, use));
diff --git a/paper-server/patches/sources/net/minecraft/world/level/TicketStorage.java.patch b/paper-server/patches/sources/net/minecraft/world/level/TicketStorage.java.patch
@@ -52,16 +52,16 @@
 +    // Paper start
 +    public boolean addPluginRegionTicket(final ChunkPos pos, final org.bukkit.plugin.Plugin value) {
 +        // Keep inline with force loading
-+        return addTicket(pos.toLong(), new Ticket(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL)); // TODO
++        return addTicket(pos.toLong(), new Ticket(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL).withPluginRef(value));
 +    }
 +
 +    public boolean removePluginRegionTicket(final ChunkPos pos, final org.bukkit.plugin.Plugin value) {
 +        // Keep inline with force loading
-+        return removeTicket(pos.toLong(), new Ticket(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL)); // TODO
++        return removeTicket(pos.toLong(), new Ticket(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL).withPluginRef(value));
 +    }
 +
-+    public <T> void removeAllTicketsFor(TicketType ticketType, int ticketLevel, T ticketIdentifier) {
-+        removeTicketIf(ticket -> ticket.getType() == ticketType && ticket.getTicketLevel() == ticketLevel, null); // TODO
++    public void removeAllPluignRegionTickets(TicketType ticketType, int ticketLevel, org.bukkit.plugin.Plugin ticketIdentifier) {
++        removeTicketIf(ticket -> ticket.getType() == ticketType && ticket.getTicketLevel() == ticketLevel && ticket.key == ticketIdentifier, null);
 +    }
 +
 +    private boolean isForced(TicketType type) {
diff --git a/paper-server/src/main/java/io/papermc/paper/PaperServerInternalAPIBridge.java b/paper-server/src/main/java/io/papermc/paper/PaperServerInternalAPIBridge.java
@@ -1,5 +1,7 @@
 package io.papermc.paper;
 
+import org.bukkit.block.Biome;
+import org.bukkit.craftbukkit.block.CraftBiome;
 import org.bukkit.craftbukkit.damage.CraftDamageEffect;
 import org.bukkit.damage.DamageEffect;
 import org.jspecify.annotations.NullMarked;
@@ -12,4 +14,12 @@ public class PaperServerInternalAPIBridge implements InternalAPIBridge {
     public DamageEffect getDamageEffect(final String key) {
         return CraftDamageEffect.getById(key);
     }
+
+    @Override
+    public Biome constructLegacyCustomBiome() {
+        class Holder {
+            static final Biome LEGACY_CUSTOM = new CraftBiome.LegacyCustomBiomeImpl();
+        }
+        return Holder.LEGACY_CUSTOM;
+    }
 }
diff --git a/paper-server/src/main/java/org/bukkit/craftbukkit/CraftWorld.java b/paper-server/src/main/java/org/bukkit/craftbukkit/CraftWorld.java
@@ -583,7 +583,7 @@ public void removePluginChunkTickets(Plugin plugin) {
         Preconditions.checkNotNull(plugin, "null plugin");
 
         DistanceManager chunkDistanceManager = this.world.getChunkSource().chunkMap.distanceManager;
-        chunkDistanceManager.ticketStorage.removeAllTicketsFor(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL, plugin);
+        chunkDistanceManager.ticketStorage.removeAllPluignRegionTickets(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL, plugin);
     }
 
     @Override
diff --git a/paper-server/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java b/paper-server/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java
@@ -479,16 +479,6 @@ public <B extends Keyed> B get(RegistryKey<B> registry, NamespacedKey namespaced
         return CraftRegistry.get(registry, namespacedKey, ApiVersion.CURRENT);
     }
 
-    private Biome customBiome;
-    @Override
-    public Biome getCustomBiome() {
-        if (this.customBiome == null) {
-            this.customBiome = new CraftBiome.LegacyCustomBiomeImpl();
-        }
-
-        return this.customBiome;
-    }
-
     @Override
     public com.destroystokyo.paper.util.VersionFetcher getVersionFetcher() {
         return new com.destroystokyo.paper.PaperVersionFetcher();

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`+`
`29`	`29`	`+ private static final Logger LOGGER = LogUtils.getLogger();`
`30`	`30`	`+ private static final ChunkStep FULL_CHUNK_STEP = ChunkPyramid.GENERATION_PYRAMID.getStepTo(ChunkStatus.FULL);`
`31`		`-+ private static final TicketType CHUNK_LOAD = TicketType.register("chunk_load", TicketType.NO_TIMEOUT, false, TicketType.TicketUse.LOADING);`
	`31`	`++ private static final TicketType CHUNK_LOAD = TicketType.CHUNK_LOAD;`
`32`	`32`	`+`
`33`	`33`	`+ private long chunkLoadCounter = 0L;`
`34`	`34`	`+`
Original file line number	Diff line number	Diff line change
`@@ -583,7 +583,7 @@ public void removePluginChunkTickets(Plugin plugin) {`
`583`	`583`	`Preconditions.checkNotNull(plugin, "null plugin");`
`584`	`584`
`585`	`585`	`DistanceManager chunkDistanceManager = this.world.getChunkSource().chunkMap.distanceManager;`
`586`		`- chunkDistanceManager.ticketStorage.removeAllTicketsFor(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL, plugin);`
	`586`	`+ chunkDistanceManager.ticketStorage.removeAllPluignRegionTickets(TicketType.PLUGIN_TICKET, ChunkMap.FORCED_TICKET_LEVEL, plugin);`
`587`	`587`	`}`
`588`	`588`
`589`	`589`	`@Override`