OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-13 21:24:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Item serialization as json

Browse source
This commit is contained in:
masmc05 2024-08-11 03:01:52 +03:00
parent e05d628610
commit cd6fb23fab
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
paper-api/src/main/java/org/bukkit/UnsafeValues.java
View file

@ -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) {