From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Jake Potrebic 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 0865830a8d9f29dee47c34a192e26e4c1304a12c..8e2942664f73b0f92beb30c7a94b720610a43c15 100644 --- a/src/main/java/org/bukkit/Bukkit.java +++ b/src/main/java/org/bukkit/Bukkit.java @@ -935,9 +935,6 @@ public final class Bukkit { /** * Create a new explorer map targeting the closest nearby structure of a * given {@link StructureType}. - *
- * 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 @@ -946,7 +943,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); @@ -969,11 +968,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}. + *
+ * 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 bc55bf7361fb41a91766fcb2f1e4620e3db64781..78daaaa3b4f1ec1d05652287d9f9b08689bc2cbf 100644 --- a/src/main/java/org/bukkit/Server.java +++ b/src/main/java/org/bukkit/Server.java @@ -800,16 +800,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}. - *
- * 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 @@ -821,9 +820,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}. + *
+ * 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.