PaperMC/patches/api/0423-Deprecate-and-replace-methods-with-old-StructureType.patch
Nassim Jahnke 31699ae9a8
Updated Upstream (Bukkit/CraftBukkit) (#10242)
* Updated Upstream (Bukkit/CraftBukkit)

Upstream has released updates that appear to apply and compile correctly.
This update has not been tested by PaperMC and as with ANY update, please do your own testing

Bukkit Changes:
a6a9d2a4 Remove some old ApiStatus.Experimental annotations
be72314c SPIGOT-7300, PR-829: Add new DamageSource API providing enhanced information about entity damage
b252cf05 SPIGOT-7576, PR-970: Add methods in MushroomCow to change stew effects
b1c689bd PR-902: Add Server#isLoggingIPs to get log-ips configuration
08f86d1c PR-971: Add Player methods for client-side potion effects
2e3024a9 PR-963: Add API for in-world structures
a23292a7 SPIGOT-7530, PR-948: Improve Resource Pack API with new 1.20.3 functionality
1851857b SPIGOT-3071, PR-969: Add entity spawn method with spawn reason
cde4c52a SPIGOT-5553, PR-964: Add EntityKnockbackEvent

CraftBukkit Changes:
38fd4bd50 Fix accidentally renamed internal damage method
80f0ce4be SPIGOT-7300, PR-1180: Add new DamageSource API providing enhanced information about entity damage
7e43f3b16 SPIGOT-7581: Fix typo in BlockMushroom
ea14b7d90 SPIGOT-7576, PR-1347: Add methods in MushroomCow to change stew effects
4c687f243 PR-1259: Add Server#isLoggingIPs to get log-ips configuration
22a541a29 Improve support for per-world game rules
cb7dccce2 PR-1348: Add Player methods for client-side potion effects
b8d6109f0 PR-1335: Add API for in-world structures
4398a1b5b SPIGOT-7577: Make CraftWindCharge#explode discard the entity
e74107678 Fix Crafter maximum stack size
0bb0f4f6a SPIGOT-7530, PR-1314: Improve Resource Pack API with new 1.20.3 functionality
4949f556d SPIGOT-3071, PR-1345: Add entity spawn method with spawn reason
20ac73ca2 PR-1353: Fix Structure#place not working as documented with 0 palette
3c1b77871 SPIGOT-6911, PR-1349: Change max book length in CraftMetaBook
333701839 SPIGOT-7572: Bee nests generated without bees
f48f4174c SPIGOT-5553, PR-1336: Add EntityKnockbackEvent
2024-02-11 22:28:00 +01:00

159 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 b82260cdee74a82b78c103467f7e2888ba4d06c1..ca27559cf4aa1c2e44fdca2022e213b1b1c80f4e 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}.
- * <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
@@ -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}.
+ * <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 f18f5db804053e072134508ef38252391895549a..b4f8281d3797ec825a7671f38077cd65d5a1d76e 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}.
- * <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
@@ -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}.
+ * <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.