mirror of
https://github.com/PaperMC/Paper.git
synced 2024-06-27 07:14:50 +02:00
bd38e0318a
Updated Upstream (Bukkit/CraftBukkit) Upstream has released updates that appear to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: f02baa38 PR-988: Add World#getIntersectingChunks(BoundingBox) 9321d665 Move getItemInUse up to LivingEntity 819eef73 PR-959: Add access to current item's remaining ticks c4fdadb0 SPIGOT-7601: Add AbstractArrow#getItem be8261ca Add support for Java 22 26119676 PR-979: Add more translation keys 66753362 PR-985: Correct book maximum pages and characters per page documentation c8be92fa PR-980: Improve getArmorContents() documentation f1120ee2 PR-983: Expose riptide velocity to PlayerRiptideEvent CraftBukkit Changes: dfaa89bbe PR-1369: Add World#getIntersectingChunks(BoundingBox) 51bbab2b9 Move getItemInUse up to LivingEntity 668e09602 PR-1331: Add access to current item's remaining ticks a639406d1 SPIGOT-7601: Add AbstractArrow#getItem 0398930fc SPIGOT-7602: Allow opening in-world horse and related inventories ffd15611c SPIGOT-7608: Allow empty lists to morph to any PDT list 2188dcfa9 Add support for Java 22 45d6a609f SPIGOT-7604: Revert "SPIGOT-7365: DamageCause blocked by shield should trigger invulnerableTime" 06d915943 SPIGOT-7365: DamageCause blocked by shield should trigger invulnerableTime ca3bc3707 PR-1361: Add more translation keys 366c3ca80 SPIGOT-7600: EntityChangeBlockEvent is not fired for frog eggs 06d0f9ba8 SPIGOT-7593: Fix sapling growth physics / client-side updates 45c2608e4 PR-1366: Expose riptide velocity to PlayerRiptideEvent 29b6bb79b SPIGOT-7587: Remove fixes for now-resolved MC-142590 and MC-109346
147 lines
5.7 KiB
Diff
147 lines
5.7 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Yannick Lamprecht <yannicklamprecht@live.de>
|
|
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 14a49bfd1822c25b95000f3fbb60ba1d55ae0d38..b9a07b2db8a3dcdb72c33c8ceda129921b2c02f1 100644
|
|
--- a/src/main/java/org/bukkit/UnsafeValues.java
|
|
+++ b/src/main/java/org/bukkit/UnsafeValues.java
|
|
@@ -300,4 +300,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
|
|
}
|