Add effective name to ItemStack (#11770)

PaperMC · Dec 25, 2024 · a07cec1 · a07cec1
1 parent 140577b
commit a07cec1
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/paper-api/src/main/java/org/bukkit/inventory/ItemStack.java b/paper-api/src/main/java/org/bukkit/inventory/ItemStack.java
@@ -5,6 +5,7 @@
 import java.util.LinkedHashMap;
 import java.util.Locale;
 import java.util.Map;
+import net.kyori.adventure.text.Component;
 import org.bukkit.Bukkit;
 import org.bukkit.Material;
 import org.bukkit.NamespacedKey;
@@ -710,6 +711,17 @@ public net.kyori.adventure.text.event.HoverEvent<net.kyori.adventure.text.event.
         return Bukkit.getServer().getItemFactory().displayName(this);
     }
 
+    /**
+     * Gets the effective name of this item stack shown to player in inventory.
+     * It takes into account the display name (with italics) from the item meta,
+     * the potion effect, translatable name, rarity etc.
+     *
+     * @return the effective name of this item stack
+     */
+    public @NotNull Component effectiveName() {
+        return this.craftDelegate.effectiveName();
+    }
+
     /**
      * Minecraft updates are converting simple item stacks into more complex NBT oriented Item Stacks.
      *

diff --git a/paper-server/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java b/paper-server/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java
@@ -5,6 +5,8 @@
 import java.util.Collections;
 import java.util.Map;
 import java.util.Optional;
+import io.papermc.paper.adventure.PaperAdventure;
+import net.kyori.adventure.text.Component;
 import net.minecraft.advancements.critereon.ItemPredicate;
 import net.minecraft.advancements.critereon.MinMaxBounds;
 import net.minecraft.core.Holder;
@@ -25,6 +27,7 @@
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.material.MaterialData;
+import org.jetbrains.annotations.NotNull;
 
 @DelegateDeserialization(ItemStack.class)
 public final class CraftItemStack extends ItemStack {
@@ -467,6 +470,11 @@ void skullCallback(final net.minecraft.world.item.component.ResolvableProfile re
         return true;
     }
 
+    @Override
+    public @NotNull Component effectiveName() {
+        return this.handle == null ? Component.empty() : PaperAdventure.asAdventure(this.handle.getStyledHoverName());
+    }
+
     @Override
     public boolean isSimilar(ItemStack stack) {
         if (stack == null) {