Replace ConfiguredStructure api with Structure (#8642)

patches/api/0249-Add-PaperRegistry.patch

@@ -90,23 +90,3 @@ index 0000000000000000000000000000000000000000..f29e76a6b66ddfec12ddf8db6dcb2df6
 +        return this.key;
 +    }
 +}
-diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 1f89a3c1c3b73a939c2653102fc1dc8b630672a8..e5e91f4b4492fa1e709d81f313aac80761ab9e07 100644
---- a/src/main/java/org/bukkit/UnsafeValues.java
-+++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -132,5 +132,15 @@ public interface UnsafeValues {
-      * Use this when sending custom packets, so that there are no collisions on the client or server.
-      */
-     public int nextEntityId();
-+
-+    /**
-+     * Gets the server-backed registry for a type.
-+     *
-+     * @param classOfT type
-+     * @param <T> type
-+     * @return the server-backed registry
-+     * @throws IllegalArgumentException if there isn't a registry for that type
-+     */
-+    <T extends Keyed> @org.jetbrains.annotations.NotNull Registry<T> registryFor(Class<T> classOfT);
-     // Paper end
- }

patches/api/0250-Add-StructuresLocateEvent.patch

@@ -170,23 +170,27 @@ index 0000000000000000000000000000000000000000..0c83a02059d65672ff191c42932d8509
 +}
 diff --git a/src/main/java/io/papermc/paper/event/world/StructuresLocateEvent.java b/src/main/java/io/papermc/paper/event/world/StructuresLocateEvent.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e83846783
+index 0000000000000000000000000000000000000000..1648ed317145eb73c0cca431823449b2adc43e04
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/event/world/StructuresLocateEvent.java
-@@ -0,0 +1,164 @@
+@@ -0,0 +1,208 @@
 +package io.papermc.paper.event.world;
 +
++import io.papermc.paper.math.Position;
++import io.papermc.paper.util.TransformingRandomAccessList;
 +import io.papermc.paper.world.structure.ConfiguredStructure;
++import java.util.Collections;
++import java.util.List;
++import java.util.Objects;
 +import org.bukkit.Location;
 +import org.bukkit.World;
 +import org.bukkit.event.Cancellable;
 +import org.bukkit.event.HandlerList;
 +import org.bukkit.event.world.WorldEvent;
++import org.bukkit.generator.structure.Structure;
 +import org.jetbrains.annotations.NotNull;
 +import org.jetbrains.annotations.Nullable;
-+
-+import java.util.ArrayList;
-+import java.util.List;
++import org.jetbrains.annotations.UnmodifiableView;
 +
 +/**
 + * Called <b>before</b> a set of configured structures is located.
@@ -206,15 +210,16 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +
 +    private final Location origin;
 +    private Result result;
-+    private List<ConfiguredStructure> configuredStructures;
++    private List<Structure> structures;
++    private List<ConfiguredStructure> legacy$structures;
 +    private int radius;
 +    private boolean findUnexplored;
 +    private boolean cancelled;
 +
-+    public StructuresLocateEvent(@NotNull World world, @NotNull Location origin, @NotNull List<ConfiguredStructure> configuredStructures, int radius, boolean findUnexplored) {
++    public StructuresLocateEvent(@NotNull World world, @NotNull Location origin, @NotNull List<Structure> structures, int radius, boolean findUnexplored) {
 +        super(world);
 +        this.origin = origin;
-+        this.configuredStructures = configuredStructures;
++        this.setStructures(structures);
 +        this.radius = radius;
 +        this.findUnexplored = findUnexplored;
 +    }
@@ -229,23 +234,23 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +    }
 +
 +    /**
-+     * Gets the {@link Location} and {@link ConfiguredStructure} set as the result, if it was defined.
++     * Gets the {@link Location} and {@link Structure} set as the result, if it was defined.
 +     * <p>
 +     * Returns {@code null} if it has not been set by {@link StructuresLocateEvent#setResult(Result)}.
 +     * Since this event fires <i>before</i> the search is done, the actual result is unknown at this point.
 +     *
 +     * @return The result location and structure, if it has been set. null if it has not.
-+     * @see World#locateNearestStructure(Location, org.bukkit.StructureType, int, boolean)
++     * @see World#locateNearestStructure(Location, org.bukkit.generator.structure.StructureType, int, boolean)
 +     */
 +    public @Nullable Result getResult() {
 +        return this.result;
 +    }
 +
 +    /**
-+     * Sets the result {@link Location} and {@link ConfiguredStructure}. This causes the search to be
++     * Sets the result {@link Location} and {@link Structure}. This causes the search to be
 +     * skipped, and the result object passed here to be used as the result.
 +     *
-+     * @param result the {@link Location} and {@link ConfiguredStructure} of the search.
++     * @param result the {@link Location} and {@link Structure} of the search.
 +     */
 +    public void setResult(@Nullable Result result) {
 +        this.result = result;
@@ -255,18 +260,41 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +     * Gets a mutable list of ConfiguredStructures that are valid targets for the search.
 +     *
 +     * @return a mutable list of ConfiguredStructures
++     * @deprecated use {@link #getStructures()}
 +     */
++    @Deprecated(forRemoval = true)
 +    public @NotNull List<ConfiguredStructure> getConfiguredStructures() {
-+        return this.configuredStructures;
++        return this.legacy$structures;
 +    }
 +
 +    /**
 +     * Sets the list of ConfiguredStructures that are valid targets for the search.
 +     *
 +     * @param configuredStructures a list of ConfiguredStructure targets
++     * @deprecated use {@link #setStructures(List)}
 +     */
++    @Deprecated(forRemoval = true)
 +    public void setConfiguredStructures(@NotNull List<ConfiguredStructure> configuredStructures) {
-+        this.configuredStructures = new ArrayList<>(configuredStructures);
++        this.setStructures(configuredStructures.stream().map(ConfiguredStructure::toModern).toList());
++    }
++
++    /**
++     * Gets an unmodifiable list of Structures that are valid targets for the search.
++     *
++     * @return an unmodifiable list of Structures
++     */
++    public @NotNull @UnmodifiableView List<Structure> getStructures() {
++        return Collections.unmodifiableList(this.structures);
++    }
++
++    /**
++     * Sets the list of Structures that are valid targets for the search.
++     *
++     * @param structures a list of Structures targets
++     */
++    public void setStructures(final @NotNull List<Structure> structures) {
++        this.structures = structures;
++        this.legacy$structures = new TransformingRandomAccessList<>(this.structures, ConfiguredStructure::fromModern, ConfiguredStructure::toModern);
 +    }
 +
 +    /**
@@ -274,7 +302,7 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +     * <p>
 +     * This radius may not always be obeyed during the structure search!
 +     *
-+     * @return the search radius.
++     * @return the search radius (in chunks)
 +     */
 +    public int getRadius() {
 +        return this.radius;
@@ -285,7 +313,7 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +     * <p>
 +     * This radius may not always be obeyed during the structure search!
 +     *
-+     * @param radius the search radius.
++     * @param radius the search radius (in chunks)
 +     */
 +    public void setRadius(int radius) {
 +        this.radius = radius;
@@ -335,31 +363,51 @@ index 0000000000000000000000000000000000000000..566f9df8f615142e14330965f3491f4e
 +    /**
 +     * Result for {@link StructuresLocateEvent}.
 +     */
-+    public record Result(@NotNull Location position, @NotNull ConfiguredStructure configuredStructure) {
++    public record Result(@NotNull Position pos, @NotNull Structure structure) {
++
++        @Deprecated(forRemoval = true)
++        public Result(final @NotNull Location position, @NotNull ConfiguredStructure configuredStructure) {
++            this(position, configuredStructure.toModern());
++        }
++
++        @Deprecated(forRemoval = true)
++        public @NotNull ConfiguredStructure configuredStructure() {
++            return Objects.requireNonNull(ConfiguredStructure.fromModern(this.structure), "Please use the newer Structure API");
++        }
++
++        @Deprecated(forRemoval = true)
++        public @NotNull Location position() {
++            //noinspection DataFlowIssue
++            return this.pos.toLocation(null);
++        }
 +    }
 +}
 diff --git a/src/main/java/io/papermc/paper/world/structure/ConfiguredStructure.java b/src/main/java/io/papermc/paper/world/structure/ConfiguredStructure.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..5a43e40b7311ed2acb51f6ba8b12d1f34569ff2e
+index 0000000000000000000000000000000000000000..b9a98f3c89cf847afd510bd1588d3a6d4b7eac0e
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/world/structure/ConfiguredStructure.java
-@@ -0,0 +1,98 @@
+@@ -0,0 +1,112 @@
 +package io.papermc.paper.world.structure;
 +
 +import io.papermc.paper.registry.Reference;
++import java.util.Objects;
 +import org.bukkit.Keyed;
 +import org.bukkit.NamespacedKey;
 +import org.bukkit.Registry;
 +import org.bukkit.StructureType;
++import org.bukkit.generator.structure.Structure;
++import org.jetbrains.annotations.ApiStatus;
 +import org.jetbrains.annotations.NotNull;
-+
-+import java.util.Objects;
++import org.jetbrains.annotations.Nullable;
 +
 +/**
 + * Represents a configured structure each with a
 + * {@link StructureType}. Multiple ConfiguredStructures can have
 + * the same {@link StructureType}.
++ * @deprecated use {@link Structure}
 + */
++@Deprecated(forRemoval = true)
 +public final class ConfiguredStructure implements Keyed {
 +
 +    public static final Reference<ConfiguredStructure> PILLAGER_OUTPOST = create("pillager_outpost");
@@ -441,12 +489,22 @@ index 0000000000000000000000000000000000000000..5a43e40b7311ed2acb51f6ba8b12d1f3
 +    private static @NotNull Reference<ConfiguredStructure> create(@NotNull String name) {
 +        return Reference.create(Registry.CONFIGURED_STRUCTURE, NamespacedKey.minecraft(name));
 +    }
++
++    @ApiStatus.Internal
++    public @NotNull Structure toModern() {
++        return Objects.requireNonNull(Registry.STRUCTURE.get(this.key));
++    }
++
++    @ApiStatus.Internal
++    public static @Nullable ConfiguredStructure fromModern(@NotNull Structure structure) {
++        return Registry.CONFIGURED_STRUCTURE.get(structure.getKey());
++    }
 +}
 diff --git a/src/main/java/org/bukkit/Registry.java b/src/main/java/org/bukkit/Registry.java
-index ff1fcdaccbca81602278a0b52670f7b895ba22b7..9e39c028b3d7bea4f2998d6ed8d53d88361ccfcd 100644
+index ff1fcdaccbca81602278a0b52670f7b895ba22b7..c0655a7c29e113297484a53d72cc5ea0affbe8ce 100644
 --- a/src/main/java/org/bukkit/Registry.java
 +++ b/src/main/java/org/bukkit/Registry.java
-@@ -211,6 +211,13 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
+@@ -211,6 +211,15 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
              return GameEvent.getByKey(key);
          }
      };
@@ -454,7 +512,9 @@ index ff1fcdaccbca81602278a0b52670f7b895ba22b7..9e39c028b3d7bea4f2998d6ed8d53d88
 +    /**
 +     * Configured structures.
 +     * @see io.papermc.paper.world.structure.ConfiguredStructure
++     * @deprecated use {@link #STRUCTURE}
 +     */
++    @Deprecated(forRemoval = true)
 +    Registry<io.papermc.paper.world.structure.ConfiguredStructure> CONFIGURED_STRUCTURE = Bukkit.getRegistry(io.papermc.paper.world.structure.ConfiguredStructure.class);
 +    // Paper end
  

patches/api/0269-Expand-world-key-API.patch

@@ -78,13 +78,13 @@ index 02b898d441c42771903d5839c3cde544b1a25778..1a3b4f20c7126caf8a34040028f73508
       * Create a new virtual {@link WorldBorder}.
       * <p>
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index e5e91f4b4492fa1e709d81f313aac80761ab9e07..3545313f1c592e29d0bb5d055fc4e5c71c8a6fca 100644
+index 1f89a3c1c3b73a939c2653102fc1dc8b630672a8..6c45841538f2f073691331f975741a62b03a6637 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -142,5 +142,10 @@ public interface UnsafeValues {
-      * @throws IllegalArgumentException if there isn't a registry for that type
+@@ -132,5 +132,10 @@ public interface UnsafeValues {
+      * Use this when sending custom packets, so that there are no collisions on the client or server.
       */
-     <T extends Keyed> @org.jetbrains.annotations.NotNull Registry<T> registryFor(Class<T> classOfT);
+     public int nextEntityId();
 +
 +    /**
 +     * Just don't use it.

patches/api/0270-Item-Rarity-API.patch

@@ -61,10 +61,10 @@ index 7e447f8be7dc9768df487e1f7f4b9aafedb33e2d..eb8aa093148eea3b2fcafe06e8f1277e
  
      /**
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 3545313f1c592e29d0bb5d055fc4e5c71c8a6fca..aa6d4e0ea2a1e2b96cc94d5a1d2223caecfea7a4 100644
+index 6c45841538f2f073691331f975741a62b03a6637..e87cbaf9c1ea1330ab1597f98c8864d0c5b8bdcd 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -147,5 +147,22 @@ public interface UnsafeValues {
+@@ -137,5 +137,22 @@ public interface UnsafeValues {
       * Just don't use it.
       */
      @org.jetbrains.annotations.NotNull String getMainLevelName();

patches/api/0271-Expose-protocol-version.patch

@@ -5,10 +5,10 @@ Subject: [PATCH] Expose protocol version
 
 
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index aa6d4e0ea2a1e2b96cc94d5a1d2223caecfea7a4..c876f95989d5bb64e745f8f62b4874422156d49c 100644
+index e87cbaf9c1ea1330ab1597f98c8864d0c5b8bdcd..906f313d8c91e65ce934143208ed281ce02f5354 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -164,5 +164,12 @@ public interface UnsafeValues {
+@@ -154,5 +154,12 @@ public interface UnsafeValues {
       * @return the itemstack rarity
       */
      public io.papermc.paper.inventory.ItemRarity getItemStackRarity(ItemStack itemStack);

patches/api/0289-ItemStack-repair-check-API.patch

@@ -5,10 +5,10 @@ Subject: [PATCH] ItemStack repair check API
 
 
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index c876f95989d5bb64e745f8f62b4874422156d49c..52e0bee77f10965932c67333e7d22cbbcdc08048 100644
+index 906f313d8c91e65ce934143208ed281ce02f5354..29a91ec8e97ce66383a1dd1fc3dcbcdcca7cfc41 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -165,6 +165,16 @@ public interface UnsafeValues {
+@@ -155,6 +155,16 @@ public interface UnsafeValues {
       */
      public io.papermc.paper.inventory.ItemRarity getItemStackRarity(ItemStack itemStack);
  

patches/api/0294-Attributes-API-for-item-defaults.patch

@@ -31,10 +31,10 @@ index eb8aa093148eea3b2fcafe06e8f1277ebbe2f275..9c6291531d3081bf601364815fdd0a9b
  
      /**
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 52e0bee77f10965932c67333e7d22cbbcdc08048..3388f31c2f287c8dcf4bfd157a04d9383cbe41e3 100644
+index 29a91ec8e97ce66383a1dd1fc3dcbcdcca7cfc41..0d47278d68cdf015cb980721c234a3abee39646a 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -175,6 +175,18 @@ public interface UnsafeValues {
+@@ -165,6 +165,18 @@ public interface UnsafeValues {
       */
      public boolean isValidRepairItemStack(@org.jetbrains.annotations.NotNull ItemStack itemToBeRepaired, @org.jetbrains.annotations.NotNull ItemStack repairMaterial);
  

patches/api/0321-Get-entity-default-attributes.patch

@@ -5,10 +5,10 @@ Subject: [PATCH] Get entity default attributes
 
 
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 3388f31c2f287c8dcf4bfd157a04d9383cbe41e3..393e0e9bacb30cdae4154ec2573e000a82cc89e7 100644
+index 0d47278d68cdf015cb980721c234a3abee39646a..29ccd90e2733b528ef0866f93053adf66dd9ddf3 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -193,5 +193,22 @@ public interface UnsafeValues {
+@@ -183,5 +183,22 @@ public interface UnsafeValues {
       * @return the server's protocol version
       */
      int getProtocolVersion();

patches/api/0327-Add-isCollidable-methods-to-various-places.patch

@@ -26,10 +26,10 @@ index 9c6291531d3081bf601364815fdd0a9b801eee50..33371518fc8c5d97625f3d528ba8fee2
  
      /**
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 393e0e9bacb30cdae4154ec2573e000a82cc89e7..aa5fff8704fa002af0cffb09049311edaef19339 100644
+index 29ccd90e2733b528ef0866f93053adf66dd9ddf3..2a23e93d9e308c5eba0a2b658f11f571a0c01e26 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -210,5 +210,14 @@ public interface UnsafeValues {
+@@ -200,5 +200,14 @@ public interface UnsafeValues {
       * @throws IllegalArgumentException if the entity does not exist of have default attributes (use {@link #hasDefaultEntityAttributes(NamespacedKey)} first)
       */
      @org.jetbrains.annotations.NotNull org.bukkit.attribute.Attributable getDefaultEntityAttributes(@org.jetbrains.annotations.NotNull NamespacedKey entityKey);

patches/api/0351-More-PotionEffectType-API.patch

@@ -5,13 +5,14 @@ Subject: [PATCH] More PotionEffectType API
 
 
 diff --git a/src/main/java/org/bukkit/Registry.java b/src/main/java/org/bukkit/Registry.java
-index 9e39c028b3d7bea4f2998d6ed8d53d88361ccfcd..3dc747080b7bfea4b04b5a47cc7ae4698c758802 100644
+index c0655a7c29e113297484a53d72cc5ea0affbe8ce..0a3a41ae4c488b148266129d3663be3f8830d509 100644
 --- a/src/main/java/org/bukkit/Registry.java
 +++ b/src/main/java/org/bukkit/Registry.java
-@@ -217,6 +217,25 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
-      * @see io.papermc.paper.world.structure.ConfiguredStructure
+@@ -219,6 +219,26 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
       */
+     @Deprecated(forRemoval = true)
      Registry<io.papermc.paper.world.structure.ConfiguredStructure> CONFIGURED_STRUCTURE = Bukkit.getRegistry(io.papermc.paper.world.structure.ConfiguredStructure.class);
++
 +    /**
 +     * Potion effect types.
 +     *

patches/api/0380-Add-NamespacedKey-biome-methods.patch

@@ -6,10 +6,10 @@ Subject: [PATCH] Add NamespacedKey biome methods
 Co-authored-by: Thonk <30448663+ExcessiveAmountsOfZombies@users.noreply.github.com>
 
 diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
-index 80314e6dabadcd290841c792f3a5fafecd6ea036..7cf5223d3f66783e05767e16000bf51925064d66 100644
+index b8ca571f8e88e7b676c5d1e1d90f6e5cb8538147..b92255a9c87620f46adb140689b1cd328a476d61 100644
 --- a/src/main/java/org/bukkit/UnsafeValues.java
 +++ b/src/main/java/org/bukkit/UnsafeValues.java
-@@ -227,5 +227,32 @@ public interface UnsafeValues {
+@@ -217,5 +217,32 @@ public interface UnsafeValues {
       * @throws IllegalArgumentException if {@link Material#isBlock()} is false
       */
      boolean isCollidable(@org.jetbrains.annotations.NotNull Material material);