Spigot / Bukkit / fa99e752ae2

Commits

Parker Hawke authored and md_5 committed fa99e752ae2 06 May 2024

#1007: Add ItemMeta#getAsComponentString()

src/main/java/org/bukkit/inventory/meta/ItemMeta.java

Modified

-3
+import com.google.common.collect.Multimap;
-4
+import java.util.Collection;
-5
+import java.util.List;
-6
+import java.util.Map;
-7
+import java.util.Set;
-8
+import org.bukkit.attribute.Attribute;
-9
+import org.bukkit.attribute.AttributeModifier;
-10
+import org.bukkit.configuration.serialization.ConfigurationSerializable;
-11
+import org.bukkit.enchantments.Enchantment;
-12
+import org.bukkit.inventory.EquipmentSlot;
-+
+import org.bukkit.inventory.ItemFactory;
-14
+import org.bukkit.inventory.ItemFlag;
-15
+import org.bukkit.inventory.ItemRarity;
-16
+import org.bukkit.inventory.meta.components.FoodComponent;
-17
+import org.bukkit.inventory.meta.tags.CustomItemTagContainer;
-18
+import org.bukkit.persistence.PersistentDataHolder;
-19
+import org.jetbrains.annotations.ApiStatus;
-20
+import org.jetbrains.annotations.NotNull;
-21
+import org.jetbrains.annotations.Nullable;
-22
-23
+/**
-531
+     * @return if any attribute modifiers were remove
-532
+     *
-533
+     * @throws NullPointerException if the Attribute is null
-534
+     * @throws NullPointerException if the AttributeModifier is null
-535
+     *
-536
+     * @see AttributeModifier#getUniqueId()
-537
+     */
-538
+    boolean removeAttributeModifier(@NotNull Attribute attribute, @NotNull AttributeModifier modifier);
-539
-540
+    /**
--
+     * Get this ItemMeta as an NBT string.
-+
+     * Get this ItemMeta as an NBT string. If this ItemMeta does not have any
-+
+     * NBT, then {@code "{}"} will be returned.
-543
+     * <p>
--
+     * This string should not be relied upon as a serializable value. If
--
+     * serialization is desired, the {@link ConfigurationSerializable} API
--
+     * should be used instead.
-+
+     * This string should <strong>NEVER</strong> be relied upon as a serializable value. If
-+
+     * serialization is desired, the {@link ConfigurationSerializable} API should be used
-+
+     * instead.
-547
+     *
-548
+     * @return the NBT string
-549
+     */
-550
+    @NotNull
-551
+    String getAsString();
-552
-+
+    /**
-+
+     * Get this ItemMeta as a component-compliant string. If this ItemMeta does
-+
+     * not contain any components, then {@code "[]"} will be returned.
-+
+     * <p>
-+
+     * The result of this method should yield a string representing the components
-+
+     * altered by this ItemMeta instance. When passed to {@link ItemFactory#createItemStack(String)}
-+
+     * with a prepended item type, it will create an ItemStack that has an ItemMeta
-+
+     * matching this ItemMeta instance exactly. Note that this method returns <strong>
-+
+     * ONLY</strong> the components and cannot be passed to createItemStack() alone.
-+
+     * An example may look something like this:
-+
+     * <pre>
-+
+     * ItemStack itemStack = // ... an item stack obtained from somewhere
-+
+     * ItemMeta itemMeta = itemStack.getItemMeta();
-+
+     *
-+
+     * String components = itemMeta.getAsComponentString(); // example: "[minecraft:damage=53]"
-+
+     * String itemTypeKey = itemStack.getType().getKey().toString(); // example: "minecraft:diamond_sword"
-+
+     * String itemAsString = itemTypeKey + components; // results in: "minecraft:diamond_sword[minecraft:damage=53]"
-+
+     *
-+
+     * ItemStack recreatedItemStack = Bukkit.getItemFactory().createItemStack(itemAsString);
-+
+     * assert itemStack.isSimilar(recreatedItemStack); // Should be true*
-+
+     * </pre>
-+
+     * <p>
-+
+     * *Components not represented or explicitly overridden by this ItemMeta instance
-+
+     * will not be included in the resulting string and therefore may result in ItemStacks
-+
+     * that do not match <em>exactly</em>. For example, if {@link #setDisplayName(String)}
-+
+     * is not set, then the custom name component will not be included. Or if this ItemMeta
-+
+     * is a PotionMeta, it will not include any components related to lodestone compasses,
-+
+     * banners, or books, etc., only components modifiable by a PotionMeta instance.
-+
+     * <p>
-+
+     * This string should <strong>NEVER</strong> be relied upon as a serializable value. If
-+
+     * serialization is desired, the {@link ConfigurationSerializable} API should be used
-+
+     * instead.
-+
+     *
-+
+     * @return the component-compliant string
-+
+     */
-+
+    @NotNull
-+
+    String getAsComponentString();
-+
-591
+    /**
-592
+     * Returns a public custom tag container capable of storing tags on the
-593
+     * item.
-594
+     *
-595
+     * Those tags will be sent to the client with all of their content, so the
-596
+     * client is capable of reading them. This will result in the player seeing
-597
+     * a NBT Tag notification on the item.
-598
+     *
-599
+     * These tags can also be modified by the client once in creative mode
-600
+     *

Bukkit

Commits

Jira Issues

Add shortcut