From 38704cdea7592db2362f51ff6402f4fa54c8e2a5 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Sat, 16 Sep 2023 13:55:40 -0700 Subject: [PATCH] [ci skip] Clarify where furnace-related events are called (#8753) --- ...for-InventoryBlockStartEvent-subclas.patch | 2 +- patches/api/Fix-upstream-javadocs.patch | 61 +++++++++++++++++++ 2 files changed, 62 insertions(+), 1 deletion(-) diff --git a/patches/api/Fix-HandlerList-for-InventoryBlockStartEvent-subclas.patch b/patches/api/Fix-HandlerList-for-InventoryBlockStartEvent-subclas.patch index 42480ac263..e18527824d 100644 --- a/patches/api/Fix-HandlerList-for-InventoryBlockStartEvent-subclas.patch +++ b/patches/api/Fix-HandlerList-for-InventoryBlockStartEvent-subclas.patch @@ -67,7 +67,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000 --- a/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java +++ b/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java @@ -0,0 +0,0 @@ import org.jetbrains.annotations.NotNull; - * Called when a Furnace starts smelting. + * {@link org.bukkit.block.Smoker}, and {@link org.bukkit.block.BlastFurnace}. */ public class FurnaceStartSmeltEvent extends InventoryBlockStartEvent { - private static final HandlerList handlers = new HandlerList(); diff --git a/patches/api/Fix-upstream-javadocs.patch b/patches/api/Fix-upstream-javadocs.patch index 3e2f5ad182..4fbef829b5 100644 --- a/patches/api/Fix-upstream-javadocs.patch +++ b/patches/api/Fix-upstream-javadocs.patch @@ -697,6 +697,67 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000 */ public class PiglinBarterEvent extends EntityEvent implements Cancellable { +diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java +index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644 +--- a/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java ++++ b/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java +@@ -0,0 +0,0 @@ import org.bukkit.inventory.ItemStack; + import org.jetbrains.annotations.NotNull; + + /** +- * Called when an ItemStack is successfully burned as fuel in a furnace. ++ * Called when an ItemStack is successfully burned as fuel in a furnace-like block such as a ++ * {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, or ++ * {@link org.bukkit.block.BlastFurnace}. + */ + public class FurnaceBurnEvent extends BlockEvent implements Cancellable { + private static final HandlerList handlers = new HandlerList(); +diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java +index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644 +--- a/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java ++++ b/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java +@@ -0,0 +0,0 @@ import org.bukkit.event.block.BlockExpEvent; + import org.jetbrains.annotations.NotNull; + + /** +- * This event is called when a player takes items out of the furnace ++ * This event is called when a player takes items out of a furnace-like block such as a ++ * {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, or ++ * {@link org.bukkit.block.BlastFurnace}. + */ + public class FurnaceExtractEvent extends BlockExpEvent { + private final Player player; +diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java +index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644 +--- a/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java ++++ b/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java +@@ -0,0 +0,0 @@ import org.bukkit.inventory.ItemStack; + import org.jetbrains.annotations.NotNull; + + /** +- * Called when an ItemStack is successfully smelted in a furnace. ++ * Called when an ItemStack is successfully smelted in a furnace-like block ++ * such as a {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, ++ * or {@link org.bukkit.block.BlastFurnace}. + */ + public class FurnaceSmeltEvent extends BlockCookEvent { + +diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java +index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644 +--- a/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java ++++ b/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java +@@ -0,0 +0,0 @@ import org.bukkit.inventory.ItemStack; + import org.jetbrains.annotations.NotNull; + + /** +- * Called when a Furnace starts smelting. ++ * Called when any of the furnace-like blocks start smelting. ++ *

++ * Furnace-like blocks are {@link org.bukkit.block.Furnace}, ++ * {@link org.bukkit.block.Smoker}, and {@link org.bukkit.block.BlastFurnace}. + */ + public class FurnaceStartSmeltEvent extends InventoryBlockStartEvent { + private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java b/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644 --- a/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java