Paper/patches/api/0407-Deprecate-and-replace-methods-with-old-StructureType.patch

160 lines
8.5 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
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 c9046e30ae9ffe90a1835316e87988ccca25fb4d..fffd4b72672d2e3f82c6a018dfc7e95b6eb3fc2d 100644
--- a/src/main/java/org/bukkit/Bukkit.java
+++ b/src/main/java/org/bukkit/Bukkit.java
@@ -938,9 +938,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
@@ -949,7 +946,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);
@@ -972,11 +971,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 e07fa603227dd936146d1bb810559df527aee0c1..6d36734580eb411b00757a1cf63a4e05acbae6b2 100644
--- a/src/main/java/org/bukkit/Server.java
+++ b/src/main/java/org/bukkit/Server.java
@@ -806,16 +806,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
@@ -827,9 +826,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.