PaperMC/patches/api/0486-Item-serialization-as-json.patch
Nassim Jahnke 52a05907c7
Updated Upstream (Bukkit/CraftBukkit) (#11543)
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:
97c59261 PR-1073: Make Biome an interface
a38581aa Fix further javadoc errors
8271c490 Fix javadoc error
8a9ecf29 PR-1072: Fix bad naming for Vault State methods
6dd58108 PR-1071: Make Fluid an interface and add missing entry
ed2cdfc3 PR-1070: Make Attribute an interface and align names with the new minecraft ones
63472efb PR-1069: Add missing winter drop experimental annotation to pale boats

CraftBukkit Changes:
7235ad7b0 PR-1501: Make Biome an interface
602904003 PR-1500: Rename implementation for Vault State methods
75f26f79f PR-1499: Make Fluid an interface and add missing entry
4cfd87adc PR-1498: Make Attribute an interface and align names with the new minecraft ones
6bb0db5cb SPIGOT-7928: ExactChoice acts as MaterialChoice
3eaf3a13c SPIGOT-7929: Error when setting EquippableComponent
abbf57bac SPIGOT-7930: Fix spawning entities with SummonEntityEffect
92d6ab6cf PR-1497: Move boat field rename entries to below key renaming, so that keys are also renamed
abfe292aa PR-1496: Use correct Fluid class on Tags type check
c7aab7fa7 SPIGOT-7923: Fix Dispenser logic to avoid firing empty projectiles
2024-10-31 23:44:34 +01:00

47 lines
2.2 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: masmc05 <masmc05@gmail.com>
Date: Sun, 11 Aug 2024 03:01:52 +0300
Subject: [PATCH] Item serialization as json
diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
index 2dd4c16ac107f58752c725540ab414ff79c46ff4..79312bdda8ef0799e2d46decc52cfdac95b97d37 100644
--- a/src/main/java/org/bukkit/UnsafeValues.java
+++ b/src/main/java/org/bukkit/UnsafeValues.java
@@ -168,6 +168,36 @@ public interface UnsafeValues {
ItemStack deserializeItem(byte[] data);
+ /**
+ * Serializes this itemstack to json format.
+ * It is safe for data migrations as it will use the built-in data converter instead of bukkit's
+ * dangerous serialization system.
+ * <p>
+ * The emitted json object's format will inherently change across versions and hence should not be used for
+ * non-development purposes like plugin configurations or end-user input.
+ *
+ * @return json object representing this item.
+ * @see #deserializeItemFromJson(com.google.gson.JsonObject)
+ * @throws IllegalArgumentException if the passed itemstack is {@link ItemStack#empty()}.
+ */
+ @NotNull
+ com.google.gson.JsonObject serializeItemAsJson(@NotNull ItemStack itemStack);
+
+ /**
+ * Creates an itemstack from a json object.
+ * <p>
+ * This method expects a json object in the format emitted by {@link #serializeItemAsJson(ItemStack)}.
+ * <p>
+ * The emitted json object's format will inherently change across versions and hence should not be used for
+ * non-development purposes like plugin configurations or end-user input.
+ *
+ * @param data object representing an item in Json format
+ * @return the deserialize item stack, migrated to the latest data version if needed.
+ * @throws IllegalArgumentException if the json object is not a valid item
+ * @see #serializeItemAsJson(ItemStack)
+ */
+ @NotNull ItemStack deserializeItemFromJson(@NotNull com.google.gson.JsonObject data) throws IllegalArgumentException;
+
byte[] serializeEntity(org.bukkit.entity.Entity entity);
default org.bukkit.entity.Entity deserializeEntity(byte[] data, World world) {