Paper/patches/api/0185-Add-item-slot-convenience-methods.patch

331 lines
9.3 KiB
Diff
Raw Permalink Normal View History

2021-06-11 14:02:28 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Nassim Jahnke <nassim@njahnke.dev>
2021-06-11 14:02:28 +02:00
Date: Sat, 25 Apr 2020 23:31:28 +0200
Subject: [PATCH] Add item slot convenience methods
Co-authored-by: Janet Blackquill <uhhadd@gmail.com>
2021-06-11 14:02:28 +02:00
diff --git a/src/main/java/org/bukkit/inventory/AnvilInventory.java b/src/main/java/org/bukkit/inventory/AnvilInventory.java
Updated Upstream (Bukkit/CraftBukkit/Spigot) (#11197) 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: 2ec53f49 PR-1050: Fix empty result check for Complex Recipes 10671012 PR-1044: Add CrafterCraftEvent 4d87ffe0 Use correct method in JavaDoc ae5e5817 SPIGOT-7850: Add API for Bogged shear state 46b6d445 SPIGOT-7837: Support data pack banner patterns d5d0cefc Fix JavaDoc error b3c2b83d PR-1036: Add API for InventoryView derivatives 1fe2c75a SPIGOT-7809: Add ShieldMeta CraftBukkit Changes: 8ee6fd1b8 SPIGOT-7857: Improve ItemMeta block data deserialization 8f26c30c6 SPIGOT-7857: Fix spurious internal NBT tag when deserializing BlockStateMeta 759061b93 SPIGOT-7855: Fire does not spread or burn blocks 00fc9fb64 SPIGOT-7853: AnvilInventory#getRepairCost() always returns 0 7501e2e04 PR-1450: Add CrafterCraftEvent 8c51673e7 SPIGOT-5731: PortalCreateEvent#getEntity returns null for nether portals ignited by flint and steel d53d0d0b1 PR-1456: Fix inverted logic in CraftCrafterView#setSlotDisabled 682a678c8 SPIGOT-7850: Add API for Bogged shear state fccf5243a SPIGOT-7837: Support data pack banner patterns 9c3bd4390 PR-1431: Add API for InventoryView derivatives 0cc6acbc4 SPIGOT-7849: Fix FoodComponent serialize with "using-converts-to" using null 2c5474952 Don't rely on tags for CraftItemMetas 20d107e46 SPIGOT-7846: Fix ItemMeta for hanging signs 76f59e315 Remove redundant clone in Dropper InventoryMoveItemEvent e61a53d25 SPIGOT-7817: Call InventoryMoveItemEvent for Crafters 894682e2d SPIGOT-7839: Remove redundant Java version checks 2c12b2187 SPIGOT-7809: Add ShieldMeta and fix setting shield base colours Spigot Changes: fb8fb722 Rebuild patches 34bd42b7 SPIGOT-7835: Fix issue with custom hopper settings
2024-08-09 22:05:50 +02:00
index 4f484df010dabf03ac4712996a0fd4d8f3649b59..f1f97a85ec713c05c882d7588f4a3e4a017f4795 100644
2021-06-11 14:02:28 +02:00
--- a/src/main/java/org/bukkit/inventory/AnvilInventory.java
+++ b/src/main/java/org/bukkit/inventory/AnvilInventory.java
Updated Upstream (Bukkit/CraftBukkit/Spigot) (#11197) 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: 2ec53f49 PR-1050: Fix empty result check for Complex Recipes 10671012 PR-1044: Add CrafterCraftEvent 4d87ffe0 Use correct method in JavaDoc ae5e5817 SPIGOT-7850: Add API for Bogged shear state 46b6d445 SPIGOT-7837: Support data pack banner patterns d5d0cefc Fix JavaDoc error b3c2b83d PR-1036: Add API for InventoryView derivatives 1fe2c75a SPIGOT-7809: Add ShieldMeta CraftBukkit Changes: 8ee6fd1b8 SPIGOT-7857: Improve ItemMeta block data deserialization 8f26c30c6 SPIGOT-7857: Fix spurious internal NBT tag when deserializing BlockStateMeta 759061b93 SPIGOT-7855: Fire does not spread or burn blocks 00fc9fb64 SPIGOT-7853: AnvilInventory#getRepairCost() always returns 0 7501e2e04 PR-1450: Add CrafterCraftEvent 8c51673e7 SPIGOT-5731: PortalCreateEvent#getEntity returns null for nether portals ignited by flint and steel d53d0d0b1 PR-1456: Fix inverted logic in CraftCrafterView#setSlotDisabled 682a678c8 SPIGOT-7850: Add API for Bogged shear state fccf5243a SPIGOT-7837: Support data pack banner patterns 9c3bd4390 PR-1431: Add API for InventoryView derivatives 0cc6acbc4 SPIGOT-7849: Fix FoodComponent serialize with "using-converts-to" using null 2c5474952 Don't rely on tags for CraftItemMetas 20d107e46 SPIGOT-7846: Fix ItemMeta for hanging signs 76f59e315 Remove redundant clone in Dropper InventoryMoveItemEvent e61a53d25 SPIGOT-7817: Call InventoryMoveItemEvent for Crafters 894682e2d SPIGOT-7839: Remove redundant Java version checks 2c12b2187 SPIGOT-7809: Add ShieldMeta and fix setting shield base colours Spigot Changes: fb8fb722 Rebuild patches 34bd42b7 SPIGOT-7835: Fix issue with custom hopper settings
2024-08-09 22:05:50 +02:00
@@ -78,4 +78,64 @@ public interface AnvilInventory extends Inventory {
2021-06-11 14:02:28 +02:00
*/
Updated Upstream (Bukkit/CraftBukkit/Spigot) (#11197) 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: 2ec53f49 PR-1050: Fix empty result check for Complex Recipes 10671012 PR-1044: Add CrafterCraftEvent 4d87ffe0 Use correct method in JavaDoc ae5e5817 SPIGOT-7850: Add API for Bogged shear state 46b6d445 SPIGOT-7837: Support data pack banner patterns d5d0cefc Fix JavaDoc error b3c2b83d PR-1036: Add API for InventoryView derivatives 1fe2c75a SPIGOT-7809: Add ShieldMeta CraftBukkit Changes: 8ee6fd1b8 SPIGOT-7857: Improve ItemMeta block data deserialization 8f26c30c6 SPIGOT-7857: Fix spurious internal NBT tag when deserializing BlockStateMeta 759061b93 SPIGOT-7855: Fire does not spread or burn blocks 00fc9fb64 SPIGOT-7853: AnvilInventory#getRepairCost() always returns 0 7501e2e04 PR-1450: Add CrafterCraftEvent 8c51673e7 SPIGOT-5731: PortalCreateEvent#getEntity returns null for nether portals ignited by flint and steel d53d0d0b1 PR-1456: Fix inverted logic in CraftCrafterView#setSlotDisabled 682a678c8 SPIGOT-7850: Add API for Bogged shear state fccf5243a SPIGOT-7837: Support data pack banner patterns 9c3bd4390 PR-1431: Add API for InventoryView derivatives 0cc6acbc4 SPIGOT-7849: Fix FoodComponent serialize with "using-converts-to" using null 2c5474952 Don't rely on tags for CraftItemMetas 20d107e46 SPIGOT-7846: Fix ItemMeta for hanging signs 76f59e315 Remove redundant clone in Dropper InventoryMoveItemEvent e61a53d25 SPIGOT-7817: Call InventoryMoveItemEvent for Crafters 894682e2d SPIGOT-7839: Remove redundant Java version checks 2c12b2187 SPIGOT-7809: Add ShieldMeta and fix setting shield base colours Spigot Changes: fb8fb722 Rebuild patches 34bd42b7 SPIGOT-7835: Fix issue with custom hopper settings
2024-08-09 22:05:50 +02:00
@Deprecated(forRemoval = true, since = "1.21")
2021-06-11 14:02:28 +02:00
void setMaximumRepairCost(int levels);
+
+ // Paper start
+ /**
+ * Gets the item in the left input slot.
+ *
+ * @return item in the first slot
+ */
+ @Nullable
+ default ItemStack getFirstItem() {
+ return getItem(0);
+ }
+
+ /**
+ * Sets the item in the left input slot.
+ *
+ * @param firstItem item to set
+ */
+ default void setFirstItem(@Nullable ItemStack firstItem) {
+ setItem(0, firstItem);
+ }
+
+ /**
+ * Gets the item in the right input slot.
+ *
+ * @return item in the second slot
+ */
+ @Nullable
+ default ItemStack getSecondItem() {
+ return getItem(1);
+ }
+
+ /**
+ * Sets the item in the right input slot.
+ *
+ * @param secondItem item to set
+ */
+ default void setSecondItem(@Nullable ItemStack secondItem) {
+ setItem(1, secondItem);
+ }
+
+ /**
+ * Gets the item in the result slot.
+ *
+ * @return item in the result slot
+ */
+ @Nullable
+ default ItemStack getResult() {
+ return getItem(2);
+ }
+
+ /**
+ * Sets the item in the result slot.
+ * Note that the client might not be able to take out the item if it does not match the input items.
+ *
+ * @param result item to set
+ */
+ default void setResult(@Nullable ItemStack result) {
+ setItem(2, result);
+ }
+ // Paper end
}
diff --git a/src/main/java/org/bukkit/inventory/CartographyInventory.java b/src/main/java/org/bukkit/inventory/CartographyInventory.java
index 29c9b2682b92433f468d434d25d3c2495b5ac91b..d040ecea3a086711acbf5a852def090ba6c51fae 100644
--- a/src/main/java/org/bukkit/inventory/CartographyInventory.java
+++ b/src/main/java/org/bukkit/inventory/CartographyInventory.java
@@ -3,4 +3,25 @@ package org.bukkit.inventory;
/**
* Interface to the inventory of a Cartography table.
*/
-public interface CartographyInventory extends Inventory { }
+public interface CartographyInventory extends Inventory {
+ // Paper begin - add getResult/setResult to CartographyInventory
+ /**
+ * Check what item is in the result slot of this smithing table.
+ *
+ * @return the result item
+ */
+ @org.jetbrains.annotations.Nullable
+ default ItemStack getResult() {
+ return this.getItem(2); // net.minecraft.world.inventory.CartographyTableMenu.RESULT_SLOT
+ }
+
+ /**
+ * Set the item in the result slot of the smithing table
+ *
+ * @param newResult the new result item
+ */
+ default void setResult(final @org.jetbrains.annotations.Nullable ItemStack newResult) {
+ this.setItem(2, newResult); // net.minecraft.world.inventory.CartographyTableMenu.RESULT_SLOT
+ }
+ // Paper end - add getResult/setResult to CartographyInventory
+}
2021-06-11 14:02:28 +02:00
diff --git a/src/main/java/org/bukkit/inventory/GrindstoneInventory.java b/src/main/java/org/bukkit/inventory/GrindstoneInventory.java
index 9048892c8768c6b4d6cea03da73339f13bfbe82e..1c750108f55a0a31ad23433b333e0ea486a63ff2 100644
--- a/src/main/java/org/bukkit/inventory/GrindstoneInventory.java
+++ b/src/main/java/org/bukkit/inventory/GrindstoneInventory.java
@@ -1,6 +1,68 @@
package org.bukkit.inventory;
+import org.jetbrains.annotations.Nullable; // Paper
+
/**
* Interface to the inventory of a Grindstone.
*/
-public interface GrindstoneInventory extends Inventory { }
+public interface GrindstoneInventory extends Inventory {
+
+ // Paper start
+ /**
+ * Gets the upper input item.
+ *
+ * @return upper input item
+ */
+ @Nullable
+ default ItemStack getUpperItem() {
+ return getItem(0);
+ }
+
+ /**
+ * Sets the upper input item.
+ *
+ * @param upperItem item to set
+ */
+ default void setUpperItem(@Nullable ItemStack upperItem) {
+ setItem(0, upperItem);
+ }
+
+ /**
+ * Gets the lower input item.
+ *
+ * @return lower input item
+ */
+ @Nullable
+ default ItemStack getLowerItem() {
+ return getItem(1);
+ }
+
+ /**
+ * Sets the lower input item.
+ *
+ * @param lowerItem item to set
+ */
+ default void setLowerItem(@Nullable ItemStack lowerItem) {
+ setItem(1, lowerItem);
+ }
+
+ /**
+ * Gets the result.
+ *
+ * @return result
+ */
+ @Nullable
+ default ItemStack getResult() {
+ return getItem(2);
+ }
+
+ /**
+ * Sets the result.
+ *
+ * @param result item to set
+ */
+ default void setResult(@Nullable ItemStack result) {
+ setItem(2, result);
+ }
+ // Paper end
+}
diff --git a/src/main/java/org/bukkit/inventory/LecternInventory.java b/src/main/java/org/bukkit/inventory/LecternInventory.java
index 4a0c43acc2714e095973eb78536041bb1a179ddc..acf2244f77133df53eb5f862c8e713c85192f13d 100644
--- a/src/main/java/org/bukkit/inventory/LecternInventory.java
+++ b/src/main/java/org/bukkit/inventory/LecternInventory.java
@@ -11,4 +11,25 @@ public interface LecternInventory extends Inventory {
@Nullable
@Override
public Lectern getHolder();
+
+ // Paper start
+ /**
+ * Gets the lectern's held book.
+ *
+ * @return book set in the lectern
+ */
+ @Nullable
+ default ItemStack getBook() {
+ return getItem(0);
+ }
+
+ /**
+ * Sets the lectern's held book.
+ *
+ * @param book the new book
+ */
+ default void setBook(@Nullable ItemStack book) {
+ setItem(0, book);
+ }
+ // Paper end
}
diff --git a/src/main/java/org/bukkit/inventory/SmithingInventory.java b/src/main/java/org/bukkit/inventory/SmithingInventory.java
index 96d526b7b153e56c9a97de42ce3270b6638510e4..5ed72b7305428f6be98a86fa9aa174d1b8ad4c17 100644
2021-06-11 14:02:28 +02:00
--- a/src/main/java/org/bukkit/inventory/SmithingInventory.java
+++ b/src/main/java/org/bukkit/inventory/SmithingInventory.java
@@ -30,4 +30,59 @@ public interface SmithingInventory extends Inventory {
2021-06-11 14:02:28 +02:00
*/
@Nullable
Recipe getRecipe();
+
+ // Paper start
+ /**
+ * Gets the input template (first slot).
+ *
+ * @return input template item
+ */
+ default @Nullable ItemStack getInputTemplate() {
+ return this.getItem(0);
+ }
+
+ /**
+ * Sets the input template (first slot).
+ *
+ * @param itemStack item to set
+ */
+ default void setInputTemplate(@Nullable ItemStack itemStack) {
+ this.setItem(0, itemStack);
+ }
+ /**
+ * Gets the input equipment (second slot).
2021-06-11 14:02:28 +02:00
+ *
+ * @return input equipment item
+ */
+ default @Nullable ItemStack getInputEquipment() {
+ return this.getItem(1);
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Sets the input equipment (second slot).
2021-06-11 14:02:28 +02:00
+ *
+ * @param itemStack item to set
+ */
+ default void setInputEquipment(@Nullable ItemStack itemStack) {
+ this.setItem(1, itemStack);
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Gets the input mineral (third slot).
2021-06-11 14:02:28 +02:00
+ *
+ * @return input mineral item
+ */
+ default @Nullable ItemStack getInputMineral() {
+ return this.getItem(2);
2021-06-11 14:02:28 +02:00
+ }
+
+ /**
+ * Sets the input mineral (third slot).
2021-06-11 14:02:28 +02:00
+ *
+ * @param itemStack item to set
+ */
+ default void setInputMineral(@Nullable ItemStack itemStack) {
+ this.setItem(2, itemStack);
2021-06-11 14:02:28 +02:00
+ }
+ // Paper end
}
diff --git a/src/main/java/org/bukkit/inventory/StonecutterInventory.java b/src/main/java/org/bukkit/inventory/StonecutterInventory.java
index dbb034fae3b8bfaf40e6341460e274c21e321a3b..e7a8e7188bf8b9840de56dc80c2b79d64a9389cb 100644
--- a/src/main/java/org/bukkit/inventory/StonecutterInventory.java
+++ b/src/main/java/org/bukkit/inventory/StonecutterInventory.java
@@ -1,6 +1,49 @@
package org.bukkit.inventory;
+import org.jetbrains.annotations.Nullable; // Paper
+
/**
* Interface to the inventory of a Stonecutter.
*/
-public interface StonecutterInventory extends Inventory { }
+public interface StonecutterInventory extends Inventory {
+
+ // Paper start
+ /**
+ * Gets the input item.
+ *
+ * @return input item
+ */
+ @Nullable
+ default ItemStack getInputItem() {
+ return getItem(0);
+ }
+
+ /**
+ * Sets the input item.
+ *
+ * @param itemStack item to set
+ */
+ default void setInputItem(@Nullable ItemStack itemStack) {
+ setItem(0, itemStack);
+ }
+
+ /**
+ * Gets the result item.
+ *
+ * @return result
+ */
+ @Nullable
+ default ItemStack getResult() {
+ return getItem(1);
+ }
+
+ /**
+ * Sets the result item.
+ *
+ * @param itemStack item to set
+ */
+ default void setResult(@Nullable ItemStack itemStack) {
+ setItem(1, itemStack);
+ }
+ // Paper end
+}