mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-30 04:02:50 +01:00
4b37929208
Remove duplicate JavaDocs - At some point upstream decided to fix some of their JD errors/warnings, so now we have duplicate tags, bringing new warnings. Also add missing `@param` for ItemStack.deserializeBytes
56 lines
2.6 KiB
Diff
56 lines
2.6 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Mariell Hoversholm <proximyst@proximyst.com>
|
|
Date: Thu, 30 Apr 2020 16:56:31 +0200
|
|
Subject: [PATCH] Add Raw Byte ItemStack Serialization
|
|
|
|
Serializes using NBT which is safer for server data migrations than bukkits format.
|
|
|
|
diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
|
|
index 541e28a9bece0beb0c2cf02c39030840b758c6e6..d3ec5084e33dff038d54cdd2aeb703a3eb25f7a7 100644
|
|
--- a/src/main/java/org/bukkit/UnsafeValues.java
|
|
+++ b/src/main/java/org/bukkit/UnsafeValues.java
|
|
@@ -90,5 +90,9 @@ public interface UnsafeValues {
|
|
static boolean isLegacyPlugin(org.bukkit.plugin.Plugin plugin) {
|
|
return !Bukkit.getUnsafe().isSupportedApiVersion(plugin.getDescription().getAPIVersion());
|
|
}
|
|
+
|
|
+ byte[] serializeItem(ItemStack item);
|
|
+
|
|
+ ItemStack deserializeItem(byte[] data);
|
|
// Paper end
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
index d7d6a3e83dfd88359708749f5c12be02815c3580..4f2520f7a4ca6d57a85924ada1068a055b9a01fb 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
@@ -613,6 +613,30 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
|
|
return Bukkit.getServer().getItemFactory().ensureServerConversions(this);
|
|
}
|
|
|
|
+ /**
|
|
+ * Deserializes this itemstack from raw NBT bytes. NBT is safer for data migrations as it will
|
|
+ * use the built in data converter instead of bukkits dangerous serialization system.
|
|
+ *
|
|
+ * This expects that the DataVersion was stored on the root of the Compound, as saved from
|
|
+ * the {@link #serializeAsBytes()} API returned.
|
|
+ * @param bytes bytes representing an item in NBT
|
|
+ * @return ItemStack migrated to this version of Minecraft if needed.
|
|
+ */
|
|
+ @NotNull
|
|
+ public static ItemStack deserializeBytes(@NotNull byte[] bytes) {
|
|
+ return org.bukkit.Bukkit.getUnsafe().deserializeItem(bytes);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Serializes this itemstack to raw bytes in NBT. NBT is safer for data migrations as it will
|
|
+ * use the built in data converter instead of bukkits dangerous serialization system.
|
|
+ * @return bytes representing this item in NBT.
|
|
+ */
|
|
+ @NotNull
|
|
+ public byte[] serializeAsBytes() {
|
|
+ return org.bukkit.Bukkit.getUnsafe().serializeItem(this);
|
|
+ }
|
|
+
|
|
/**
|
|
* Gets the Display name as seen in the Client.
|
|
* Currently the server only supports the English language. To override this,
|