Deprecate and replace methods using deprecated StructureType (#8643)

1 files changed, 159 insertions, 0 deletions

diff --git a/patches/api/0426-Deprecate-and-replace-methods-with-old-StructureType.patch b/patches/api/0426-Deprecate-and-replace-methods-with-old-StructureType.patch
new file mode 100644
index 0000000000..086f74e691
--- /dev/null
+++ b/patches/api/0426-Deprecate-and-replace-methods-with-old-StructureType.patch
@@ -0,0 +1,159 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Jake Potrebic <[email protected]>
+Date: Sat, 10 Dec 2022 17:52:45 -0800
+Subject: [PATCH] Deprecate and replace methods with old StructureType
+
+
+diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java
+index f380a518bc444bfdfbbedf38805c7684e53a5629..f78b5fd3c3347d28da58777bff88903d2eb140f6 100644
+--- a/src/main/java/org/bukkit/Bukkit.java
++++ b/src/main/java/org/bukkit/Bukkit.java
+@@ -915,7 +915,9 @@ public final class Bukkit {
+      *
+      * @see World#locateNearestStructure(org.bukkit.Location,
+      *      org.bukkit.StructureType, int, boolean)
++     * @deprecated use {@link #createExplorerMap(World, Location, org.bukkit.generator.structure.StructureType, org.bukkit.map.MapCursor.Type)}
+      */
++    @Deprecated // Paper
+     @NotNull
+     public static ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType) {
+         return server.createExplorerMap(world, location, structureType);
+@@ -924,9 +926,6 @@ public final class Bukkit {
+     /**
+      * Create a new explorer map targeting the closest nearby structure of a
+      * given {@link StructureType}.
+-     * <br>
+-     * This method uses implementation default values for radius and
+-     * findUnexplored (usually 100, true).
+      *
+      * @param world the world the map will belong to
+      * @param location the origin location to find the nearest structure
+@@ -938,11 +937,54 @@ public final class Bukkit {
+      *
+      * @see World#locateNearestStructure(org.bukkit.Location,
+      *      org.bukkit.StructureType, int, boolean)
++     * @deprecated use {@link #createExplorerMap(World, Location, org.bukkit.generator.structure.StructureType, org.bukkit.map.MapCursor.Type, int, boolean)}
+      */
++    @Deprecated // Paper
+     @NotNull
+     public static ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType, int radius, boolean findUnexplored) {
+         return server.createExplorerMap(world, location, structureType, radius, findUnexplored);
+     }
++    // Paper start
++    /**
++     * Create a new explorer map targeting the closest nearby structure of a
++     * given {@link org.bukkit.generator.structure.StructureType}.
++     * <br>
++     * This method uses implementation default values for radius and
++     * findUnexplored (usually 100, true).
++     *
++     * @param world the world the map will belong to
++     * @param location the origin location to find the nearest structure
++     * @param structureType the type of structure to find
++     * @param mapIcon the map icon to use on the map
++     * @return a newly created item stack or null if it can't find a location
++     *
++     * @see World#locateNearestStructure(org.bukkit.Location,
++     *      org.bukkit.generator.structure.StructureType, int, boolean)
++     */
++    public static @Nullable ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull org.bukkit.generator.structure.StructureType structureType, @NotNull org.bukkit.map.MapCursor.Type mapIcon) {
++        return server.createExplorerMap(world, location, structureType, mapIcon);
++    }
++
++    /**
++     * Create a new explorer map targeting the closest nearby structure of a
++     * given {@link org.bukkit.generator.structure.StructureType}.
++     *
++     * @param world the world the map will belong to
++     * @param location the origin location to find the nearest structure
++     * @param structureType the type of structure to find
++     * @param mapIcon the map icon to use on the map
++     * @param radius radius to search, see World#locateNearestStructure for more
++     *               information
++     * @param findUnexplored whether to find unexplored structures
++     * @return the newly created item stack or null if it can't find a location
++     *
++     * @see World#locateNearestStructure(org.bukkit.Location,
++     *      org.bukkit.generator.structure.StructureType, int, boolean)
++     */
++    public static @Nullable ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull org.bukkit.generator.structure.StructureType structureType, @NotNull org.bukkit.map.MapCursor.Type mapIcon, int radius, boolean findUnexplored) {
++        return server.createExplorerMap(world, location, structureType, mapIcon, radius, findUnexplored);
++    }
++    // Paper end
+ 
+     /**
+      * Reloads the server, refreshing settings and plugin information.
+diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java
+index 68206cf0178c26c0f528a1e14a5fb4e9ad410369..8d8fe04e6b09d2a5b1cc05002073df5c58cdcb96 100644
+--- a/src/main/java/org/bukkit/Server.java
++++ b/src/main/java/org/bukkit/Server.java
+@@ -775,16 +775,15 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
+      *
+      * @see World#locateNearestStructure(org.bukkit.Location,
+      *      org.bukkit.StructureType, int, boolean)
++     * @deprecated use {@link #createExplorerMap(World, Location, org.bukkit.generator.structure.StructureType, org.bukkit.map.MapCursor.Type)}
+      */
++    @Deprecated // Paper
+     @NotNull
+     public ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType);
+ 
+     /**
+      * Create a new explorer map targeting the closest nearby structure of a
+      * given {@link StructureType}.
+-     * <br>
+-     * This method uses implementation default values for radius and
+-     * findUnexplored (usually 100, true).
+      *
+      * @param world the world the map will belong to
+      * @param location the origin location to find the nearest structure
+@@ -796,9 +795,50 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
+      *
+      * @see World#locateNearestStructure(org.bukkit.Location,
+      *      org.bukkit.StructureType, int, boolean)
++     * @deprecated use {@link #createExplorerMap(World, Location, org.bukkit.generator.structure.StructureType, org.bukkit.map.MapCursor.Type, int, boolean)}
+      */
++    @Deprecated // Paper
+     @NotNull
+     public ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull StructureType structureType, int radius, boolean findUnexplored);
++    // Paper start
++    /**
++     * Create a new explorer map targeting the closest nearby structure of a
++     * given {@link org.bukkit.generator.structure.StructureType}.
++     * <br>
++     * This method uses implementation default values for radius and
++     * findUnexplored (usually 100, true).
++     *
++     * @param world the world the map will belong to
++     * @param location the origin location to find the nearest structure
++     * @param structureType the type of structure to find
++     * @param mapIcon the map icon to use on the map
++     * @return a newly created item stack or null if it can't find a location
++     *
++     * @see World#locateNearestStructure(org.bukkit.Location,
++     *      org.bukkit.generator.structure.StructureType, int, boolean)
++     */
++    default @Nullable ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull org.bukkit.generator.structure.StructureType structureType, @NotNull org.bukkit.map.MapCursor.Type mapIcon) {
++        return this.createExplorerMap(world, location, structureType, mapIcon, 100, true);
++    }
++
++    /**
++     * Create a new explorer map targeting the closest nearby structure of a
++     * given {@link org.bukkit.generator.structure.StructureType}.
++     *
++     * @param world the world the map will belong to
++     * @param location the origin location to find the nearest structure
++     * @param structureType the type of structure to find
++     * @param mapIcon the map icon to use on the map
++     * @param radius radius to search, see World#locateNearestStructure for more
++     *               information
++     * @param findUnexplored whether to find unexplored structures
++     * @return the newly created item stack or null if it can't find a location
++     *
++     * @see World#locateNearestStructure(org.bukkit.Location,
++     *      org.bukkit.generator.structure.StructureType, int, boolean)
++     */
++    @Nullable ItemStack createExplorerMap(@NotNull World world, @NotNull Location location, @NotNull org.bukkit.generator.structure.StructureType structureType, @NotNull org.bukkit.map.MapCursor.Type mapIcon, int radius, boolean findUnexplored);
++    // Paper end
+ 
+     /**
+      * Reloads the server, refreshing settings and plugin information.