itemstack expose tooltip lines (#10185)

* Itemstack Tooltip API

* re-order methods so advanced is first

---------

Co-authored-by: Jake Potrebic <[email protected]>

2 files changed, 175 insertions, 0 deletions

diff --git a/patches/api/0461-ItemStack-Tooltip-API.patch b/patches/api/0461-ItemStack-Tooltip-API.patch
new file mode 100644
index 0000000000..c7710b7c4c
--- /dev/null
+++ b/patches/api/0461-ItemStack-Tooltip-API.patch
@@ -0,0 +1,146 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Yannick Lamprecht <[email protected]>
+Date: Mon, 22 Jan 2024 13:27:18 +0100
+Subject: [PATCH] ItemStack Tooltip API
+
+
+diff --git a/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContext.java b/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContext.java
+new file mode 100644
+index 0000000000000000000000000000000000000000..39ac768b3c5148544cb1aaf2c817e661f6856f64
+--- /dev/null
++++ b/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContext.java
+@@ -0,0 +1,75 @@
++package io.papermc.paper.inventory.tooltip;
++
++import org.bukkit.entity.Player;
++import org.jetbrains.annotations.Contract;
++import org.jetbrains.annotations.NotNull;
++
++/**
++ * Context for computing itemstack tooltips via
++ * {@link org.bukkit.inventory.ItemStack#computeTooltipLines(TooltipContext, Player)}
++ */
++public interface TooltipContext {
++
++    /**
++     * Creates a new context with the given advanced and creative
++     * mode settings.
++     *
++     * @param advanced whether the context is for advanced tooltips
++     * @param creative whether the context is for the creative inventory
++     * @return a new context
++     */
++    @Contract("_, _ -> new")
++    static @NotNull TooltipContext create(final boolean advanced, final boolean creative) {
++        return new TooltipContextImpl(advanced, creative);
++    }
++
++    /**
++     * Creates a new context that is neither advanced nor creative.
++     *
++     * @return a new context
++     */
++    @Contract("-> new")
++    static @NotNull TooltipContext create() {
++        return new TooltipContextImpl(false, false);
++    }
++
++    /**
++     * Returns whether the context is for advanced
++     * tooltips.
++     * <p>
++     * Advanced tooltips are shown by default
++     * when a player has {@code F3+H} enabled.
++     *
++     * @return true if for advanced tooltips
++     */
++    boolean isAdvanced();
++
++    /**
++     * Returns whether the context is for the creative
++     * mode inventory.
++     * <p>
++     * Creative tooltips are shown by default when a player is
++     * in the creative inventory.
++     *
++     * @return true if for creative mode inventory
++     */
++    boolean isCreative();
++
++    /**
++     * Returns a new context with {@link #isAdvanced()}
++     * set to true.
++     *
++     * @return a new context
++     */
++    @Contract("-> new")
++    @NotNull TooltipContext asAdvanced();
++
++    /**
++     * Returns a new context with {@link #isCreative()}
++     * set to true.
++     *
++     * @return a new context
++     */
++    @Contract("-> new")
++    @NotNull TooltipContext asCreative();
++}
+diff --git a/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContextImpl.java b/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContextImpl.java
+new file mode 100644
+index 0000000000000000000000000000000000000000..1d9bed6691f581529c53b577b26f1d0f902ccb0d
+--- /dev/null
++++ b/src/main/java/io/papermc/paper/inventory/tooltip/TooltipContextImpl.java
+@@ -0,0 +1,16 @@
++package io.papermc.paper.inventory.tooltip;
++
++import org.jetbrains.annotations.NotNull;
++
++record TooltipContextImpl(boolean isCreative, boolean isAdvanced) implements TooltipContext {
++
++    @Override
++    public @NotNull TooltipContext asCreative() {
++        return new TooltipContextImpl(true, this.isAdvanced);
++    }
++
++    @Override
++    public @NotNull TooltipContext asAdvanced() {
++        return new TooltipContextImpl(this.isCreative, true);
++    }
++}
+diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java
+index 890c07cfc2e64a52752e96d518578b5eb1afbd19..c6222fe754dee53f269944c7578dde8106377f20 100644
+--- a/src/main/java/org/bukkit/UnsafeValues.java
++++ b/src/main/java/org/bukkit/UnsafeValues.java
+@@ -281,4 +281,6 @@ public interface UnsafeValues {
+     @org.jetbrains.annotations.ApiStatus.Internal
+     io.papermc.paper.plugin.lifecycle.event.LifecycleEventManager<org.bukkit.plugin.Plugin> createPluginLifecycleEventManager(final org.bukkit.plugin.java.JavaPlugin plugin, final java.util.function.BooleanSupplier registrationCheck);
+     // Paper end - lifecycle event API
++
++    @NotNull java.util.List<net.kyori.adventure.text.Component> computeTooltipLines(@NotNull ItemStack itemStack, @NotNull io.papermc.paper.inventory.tooltip.TooltipContext tooltipContext, @Nullable org.bukkit.entity.Player player); // Paper - expose itemstack tooltip lines
+ }
+diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
+index 7adf54c561d64e6337af8a2d86f6b574b083edb5..245a730a54c4b241a9a67eccceefafd2763bd238 100644
+--- a/src/main/java/org/bukkit/inventory/ItemStack.java
++++ b/src/main/java/org/bukkit/inventory/ItemStack.java
+@@ -1016,4 +1016,21 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, Translat
+         return type.isAir() || amount <= 0;
+     }
+     // Paper end
++    // Paper start - expose itemstack tooltip lines
++    /**
++     * Computes the tooltip lines for this stack.
++     * <p>
++     * <b>Disclaimer:</b>
++     * Tooltip contents are not guaranteed to be consistent across different
++     * Minecraft versions.
++     *
++     * @param tooltipContext the tooltip context
++     * @param player a player for player-specific tooltip lines
++     * @return an immutable list of components (can be empty)
++     */
++    @SuppressWarnings("deprecation") // abusing unsafe as a bridge
++    public @NotNull @org.jetbrains.annotations.Unmodifiable List<net.kyori.adventure.text.Component> computeTooltipLines(final @NotNull io.papermc.paper.inventory.tooltip.TooltipContext tooltipContext, final @Nullable org.bukkit.entity.Player player) {
++        return Bukkit.getUnsafe().computeTooltipLines(this, tooltipContext, player);
++    }
++    // Paper end - expose itemstack tooltip lines
+ }
diff --git a/patches/server/1048-ItemStack-Tooltip-API.patch b/patches/server/1048-ItemStack-Tooltip-API.patch
new file mode 100644
index 0000000000..0f761e26a7
--- /dev/null
+++ b/patches/server/1048-ItemStack-Tooltip-API.patch
@@ -0,0 +1,29 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Yannick Lamprecht <[email protected]>
+Date: Mon, 22 Jan 2024 13:27:30 +0100
+Subject: [PATCH] ItemStack Tooltip API
+
+
+diff --git a/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java b/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java
+index f276c5163d29d56cf4ed081d8e75cbcfd28d892f..8036ed91714d638eb2a8e8c2bea4bf62bc18cb57 100644
+--- a/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java
++++ b/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java
+@@ -644,6 +644,18 @@ public final class CraftMagicNumbers implements UnsafeValues {
+         return org.bukkit.craftbukkit.CraftStatistic.getNMSStatistic(statistic).getName();
+     }
+     // Paper end
++    // Paper start - expose itemstack tooltip lines
++    @Override
++    public List<net.kyori.adventure.text.Component> computeTooltipLines(final ItemStack itemStack, final io.papermc.paper.inventory.tooltip.TooltipContext tooltipContext, final org.bukkit.entity.Player player) {
++        Preconditions.checkArgument(tooltipContext != null, "tooltipContext cannot be null");
++        net.minecraft.world.item.TooltipFlag.Default flag = tooltipContext.isAdvanced() ? net.minecraft.world.item.TooltipFlag.ADVANCED : net.minecraft.world.item.TooltipFlag.NORMAL;
++        if (tooltipContext.isCreative()) {
++            flag = flag.asCreative();
++        }
++        final List<net.minecraft.network.chat.Component> lines = CraftItemStack.asNMSCopy(itemStack).getTooltipLines(player == null ? null : ((org.bukkit.craftbukkit.entity.CraftPlayer) player).getHandle(), flag);
++        return lines.stream().map(io.papermc.paper.adventure.PaperAdventure::asAdventure).toList();
++    }
++    // Paper end - expose itemstack tooltip lines
+ 
+     // Paper start - spawn egg color visibility
+     @Override