From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Mariell Hoversholm 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 d6897f43a0692e031bed8a212d9a637ef548cc60..e348034288c74ab80360086d71f0b7f61551df24 100644 --- a/src/main/java/org/bukkit/UnsafeValues.java +++ b/src/main/java/org/bukkit/UnsafeValues.java @@ -97,5 +97,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 bf39989dbe08c93120d75bed6281ae75c460afca..15b48ad1ba5bcf7394fb3f52ce2cc6baa6632f66 100644 --- a/src/main/java/org/bukkit/inventory/ItemStack.java +++ b/src/main/java/org/bukkit/inventory/ItemStack.java @@ -628,6 +628,30 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, net.kyor 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,