diff --git a/patches/minecraft/net/minecraft/client/gui/screens/Screen.java.patch b/patches/minecraft/net/minecraft/client/gui/screens/Screen.java.patch index 6e5095e9b3..a5582eef09 100644 --- a/patches/minecraft/net/minecraft/client/gui/screens/Screen.java.patch +++ b/patches/minecraft/net/minecraft/client/gui/screens/Screen.java.patch @@ -9,69 +9,128 @@ } protected T m_142416_(T p_169406_) { -@@ -163,7 +_,10 @@ +@@ -162,15 +_,29 @@ + this.f_169368_.clear(); } ++ private Font tooltipFont = null; ++ private ItemStack tooltipStack = ItemStack.f_41583_; protected void m_6057_(PoseStack p_96566_, ItemStack p_96567_, int p_96568_, int p_96569_) { -- this.m_169388_(p_96566_, this.m_96555_(p_96567_), p_96567_.m_150921_(), p_96568_, p_96569_); -+ Font font = net.minecraftforge.client.RenderProperties.get(p_96567_).getFont(p_96567_); -+ net.minecraftforge.fmlclient.gui.GuiUtils.preItemToolTip(p_96567_); -+ this.renderComponentToolTip(p_96566_, this.m_96555_(p_96567_), p_96568_, p_96569_, (font == null ? this.f_96547_ : font)); -+ net.minecraftforge.fmlclient.gui.GuiUtils.postItemToolTip(); ++ tooltipStack = p_96567_; + this.m_169388_(p_96566_, this.m_96555_(p_96567_), p_96567_.m_150921_(), p_96568_, p_96569_); ++ tooltipStack = ItemStack.f_41583_; } ++ public void renderTooltip(PoseStack poseStack, List textComponents, Optional tooltipComponent, int x, int y, ItemStack stack) { ++ this.renderTooltip(poseStack, textComponents, tooltipComponent, x, y, null, stack); ++ } ++ public void renderTooltip(PoseStack poseStack, List textComponents, Optional tooltipComponent, int x, int y, @Nullable Font font) { ++ this.renderTooltip(poseStack, textComponents, tooltipComponent, x, y, font, ItemStack.f_41583_); ++ } ++ public void renderTooltip(PoseStack poseStack, List textComponents, Optional tooltipComponent, int x, int y, @Nullable Font font, ItemStack stack) { ++ this.tooltipFont = font; ++ this.tooltipStack = stack; ++ this.m_169388_(poseStack, textComponents, tooltipComponent, x, y); ++ this.tooltipFont = null; ++ this.tooltipStack = ItemStack.f_41583_; ++ } public void m_169388_(PoseStack p_169389_, List p_169390_, Optional p_169391_, int p_169392_, int p_169393_) { -@@ -171,7 +_,7 @@ - p_169391_.ifPresent((p_169399_) -> { - list.add(1, ClientTooltipComponent.m_169950_(p_169399_)); - }); -- this.m_169383_(p_169389_, list, p_169392_, p_169393_); -+ this.renderTooltipInternal(p_169389_, list, p_169392_, p_169393_, f_96547_); +- List list = p_169390_.stream().map(Component::m_7532_).map(ClientTooltipComponent::m_169948_).collect(Collectors.toList()); +- p_169391_.ifPresent((p_169399_) -> { +- list.add(1, ClientTooltipComponent.m_169950_(p_169399_)); +- }); ++ List list = net.minecraftforge.client.ForgeHooksClient.gatherTooltipComponents(this.tooltipStack, p_169390_, p_169391_, p_169392_, f_96543_, f_96544_, this.tooltipFont, this.f_96547_); + this.m_169383_(p_169389_, list, p_169392_, p_169393_); } - public List m_96555_(ItemStack p_96556_) { -@@ -179,24 +_,30 @@ - } - - public void m_96602_(PoseStack p_96603_, Component p_96604_, int p_96605_, int p_96606_) { -- this.m_96617_(p_96603_, Arrays.asList(p_96604_.m_7532_()), p_96605_, p_96606_); -+ this.m_96597_(p_96603_, Arrays.asList(p_96604_), p_96605_, p_96606_); +@@ -183,20 +_,42 @@ } public void m_96597_(PoseStack p_96598_, List p_96599_, int p_96600_, int p_96601_) { - this.m_96617_(p_96598_, Lists.transform(p_96599_, Component::m_7532_), p_96600_, p_96601_); -+ this.renderComponentToolTip(p_96598_, p_96599_, p_96600_, p_96601_, f_96547_); ++ List components = net.minecraftforge.client.ForgeHooksClient.gatherTooltipComponents(this.tooltipStack, p_96599_, p_96600_, f_96543_, f_96544_, this.tooltipFont, this.f_96547_); ++ this.m_169383_(p_96598_, components, p_96600_, p_96601_); + } -+ public void renderComponentToolTip(PoseStack matrixStack, List tooltips, int mouseX, int mouseY, Font font) { -+ net.minecraftforge.fmlclient.gui.GuiUtils.drawHoveringText(matrixStack, tooltips, mouseX, mouseY, f_96543_, f_96544_, -1, font); ++ public void renderComponentTooltip(PoseStack poseStack, List tooltips, int mouseX, int mouseY, ItemStack stack) { ++ this.renderComponentToolTip(poseStack, tooltips, mouseX, mouseY, null, stack); ++ } ++ public void renderComponentTooltip(PoseStack poseStack, List tooltips, int mouseX, int mouseY, @Nullable Font font) { ++ this.renderComponentToolTip(poseStack, tooltips, mouseX, mouseY, font, ItemStack.f_41583_); ++ } ++ public void renderComponentToolTip(PoseStack poseStack, List tooltips, int mouseX, int mouseY, @Nullable Font font, ItemStack stack) { ++ this.tooltipFont = font; ++ this.tooltipStack = stack; ++ List components = net.minecraftforge.client.ForgeHooksClient.gatherTooltipComponents(stack, tooltips, mouseX, f_96543_, f_96544_, this.tooltipFont, font); ++ this.m_169383_(poseStack, components, mouseX, mouseY); ++ this.tooltipFont = null; ++ this.tooltipStack = null; } public void m_96617_(PoseStack p_96618_, List p_96619_, int p_96620_, int p_96621_) { -- this.m_169383_(p_96618_, p_96619_.stream().map(ClientTooltipComponent::m_169948_).collect(Collectors.toList()), p_96620_, p_96621_); -+ this.renderToolTip(p_96618_, p_96619_, p_96620_, p_96621_, f_96547_); -+ } -+ public void renderToolTip(PoseStack p_96618_, List p_96619_, int p_96620_, int p_96621_, Font font) { -+ this.renderTooltipInternal(p_96618_, p_96619_.stream().map(ClientTooltipComponent::m_169948_).collect(Collectors.toList()), p_96620_, p_96621_, font); + this.m_169383_(p_96618_, p_96619_.stream().map(ClientTooltipComponent::m_169948_).collect(Collectors.toList()), p_96620_, p_96621_); } ++ public void renderTooltip(PoseStack poseStack, List lines, int x, int y, Font font) { ++ this.tooltipFont = font; ++ this.m_96617_(poseStack, lines, x, y); ++ this.tooltipFont = null; ++ } -- private void m_169383_(PoseStack p_169384_, List p_169385_, int p_169386_, int p_169387_) { -+ private void renderTooltipInternal(PoseStack p_169384_, List p_169385_, int p_169386_, int p_169387_, Font font) { + private void m_169383_(PoseStack p_169384_, List p_169385_, int p_169386_, int p_169387_) { if (!p_169385_.isEmpty()) { ++ net.minecraftforge.client.event.RenderTooltipEvent.Pre preEvent = net.minecraftforge.client.ForgeHooksClient.preTooltipEvent(this.tooltipStack, p_169384_, p_169386_, p_169387_, f_96543_, f_96544_, p_169385_, this.tooltipFont, this.f_96547_); ++ if (preEvent.isCanceled()) return; int i = 0; int j = p_169385_.size() == 1 ? -2 : 0; for(ClientTooltipComponent clienttooltipcomponent : p_169385_) { - int k = clienttooltipcomponent.m_142069_(this.f_96547_); -+ int k = clienttooltipcomponent.m_142069_(font); ++ int k = clienttooltipcomponent.m_142069_(preEvent.getFontRenderer()); if (k > i) { i = k; } +@@ -204,8 +_,8 @@ + j += clienttooltipcomponent.m_142103_(); + } + +- int j2 = p_169386_ + 12; +- int k2 = p_169387_ - 12; ++ int j2 = preEvent.getX() + 12; ++ int k2 = preEvent.getY() - 12; + if (j2 + i > this.f_96543_) { + j2 -= 28 + i; + } +@@ -226,15 +_,16 @@ + RenderSystem.m_157427_(GameRenderer::m_172811_); + bufferbuilder.m_166779_(VertexFormat.Mode.QUADS, DefaultVertexFormat.f_85815_); + Matrix4f matrix4f = p_169384_.m_85850_().m_85861_(); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 4, j2 + i + 3, k2 - 3, 400, -267386864, -267386864); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 + j + 3, j2 + i + 3, k2 + j + 4, 400, -267386864, -267386864); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3, j2 + i + 3, k2 + j + 3, 400, -267386864, -267386864); +- m_93123_(matrix4f, bufferbuilder, j2 - 4, k2 - 3, j2 - 3, k2 + j + 3, 400, -267386864, -267386864); +- m_93123_(matrix4f, bufferbuilder, j2 + i + 3, k2 - 3, j2 + i + 4, k2 + j + 3, 400, -267386864, -267386864); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3 + 1, j2 - 3 + 1, k2 + j + 3 - 1, 400, 1347420415, 1344798847); +- m_93123_(matrix4f, bufferbuilder, j2 + i + 2, k2 - 3 + 1, j2 + i + 3, k2 + j + 3 - 1, 400, 1347420415, 1344798847); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3, j2 + i + 3, k2 - 3 + 1, 400, 1347420415, 1347420415); +- m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 + j + 2, j2 + i + 3, k2 + j + 3, 400, 1344798847, 1344798847); ++ net.minecraftforge.client.event.RenderTooltipEvent.Color colorEvent = net.minecraftforge.client.ForgeHooksClient.colorTooltipEvent(this.tooltipStack, p_169384_, j2, k2, preEvent.getFontRenderer(), p_169385_); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 4, j2 + i + 3, k2 - 3, 400, colorEvent.getBackgroundStart(), colorEvent.getBackgroundStart()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 + j + 3, j2 + i + 3, k2 + j + 4, 400, colorEvent.getBackgroundEnd(), colorEvent.getBackgroundEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3, j2 + i + 3, k2 + j + 3, 400, colorEvent.getBackgroundStart(), colorEvent.getBackgroundEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 4, k2 - 3, j2 - 3, k2 + j + 3, 400, colorEvent.getBackgroundStart(), colorEvent.getBackgroundEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 + i + 3, k2 - 3, j2 + i + 4, k2 + j + 3, 400, colorEvent.getBackgroundStart(), colorEvent.getBackgroundEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3 + 1, j2 - 3 + 1, k2 + j + 3 - 1, 400, colorEvent.getBorderStart(), colorEvent.getBorderEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 + i + 2, k2 - 3 + 1, j2 + i + 3, k2 + j + 3 - 1, 400, colorEvent.getBorderStart(), colorEvent.getBorderEnd()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 - 3, j2 + i + 3, k2 - 3 + 1, 400, colorEvent.getBorderStart(), colorEvent.getBorderStart()); ++ m_93123_(matrix4f, bufferbuilder, j2 - 3, k2 + j + 2, j2 + i + 3, k2 + j + 3, 400, colorEvent.getBorderEnd(), colorEvent.getBorderEnd()); + RenderSystem.m_69482_(); + RenderSystem.m_69472_(); + RenderSystem.m_69478_(); @@ -249,7 +_,7 @@ for(int i2 = 0; i2 < p_169385_.size(); ++i2) { ClientTooltipComponent clienttooltipcomponent1 = p_169385_.get(i2); - clienttooltipcomponent1.m_142440_(this.f_96547_, j2, l1, matrix4f, multibuffersource$buffersource); -+ clienttooltipcomponent1.m_142440_(font, j2, l1, matrix4f, multibuffersource$buffersource); ++ clienttooltipcomponent1.m_142440_(preEvent.getFontRenderer(), j2, l1, matrix4f, multibuffersource$buffersource); l1 += clienttooltipcomponent1.m_142103_() + (i2 == 0 ? 2 : 0); } @@ -80,7 +139,7 @@ for(int l2 = 0; l2 < p_169385_.size(); ++l2) { ClientTooltipComponent clienttooltipcomponent2 = p_169385_.get(l2); - clienttooltipcomponent2.m_142162_(this.f_96547_, j2, l1, p_169384_, this.f_96542_, 400, this.f_96541_.m_91097_()); -+ clienttooltipcomponent2.m_142162_(font, j2, l1, p_169384_, this.f_96542_, 400, this.f_96541_.m_91097_()); ++ clienttooltipcomponent2.m_142162_(preEvent.getFontRenderer(), j2, l1, p_169384_, this.f_96542_, 400, this.f_96541_.m_91097_()); l1 += clienttooltipcomponent2.m_142103_() + (l2 == 0 ? 2 : 0); } diff --git a/patches/minecraft/net/minecraft/client/gui/screens/inventory/CreativeModeInventoryScreen.java.patch b/patches/minecraft/net/minecraft/client/gui/screens/inventory/CreativeModeInventoryScreen.java.patch index 342057ee45..deb5463f41 100644 --- a/patches/minecraft/net/minecraft/client/gui/screens/inventory/CreativeModeInventoryScreen.java.patch +++ b/patches/minecraft/net/minecraft/client/gui/screens/inventory/CreativeModeInventoryScreen.java.patch @@ -173,15 +173,12 @@ RenderSystem.m_157429_(1.0F, 1.0F, 1.0F, 1.0F); this.m_7025_(p_98577_, p_98578_, p_98579_); } -@@ -620,7 +_,10 @@ +@@ -620,7 +_,7 @@ list1.add(1, creativemodetab.m_40786_().m_6881_().m_130940_(ChatFormatting.BLUE)); } - this.m_169388_(p_98590_, list1, p_98591_.m_150921_(), p_98592_, p_98593_); -+ net.minecraft.client.gui.Font font = net.minecraftforge.client.RenderProperties.get(p_98591_).getFont(p_98591_); -+ net.minecraftforge.fmlclient.gui.GuiUtils.preItemToolTip(p_98591_); -+ this.renderComponentToolTip(p_98590_, list1, p_98592_, p_98593_, (font == null ? this.f_96547_ : font)); -+ net.minecraftforge.fmlclient.gui.GuiUtils.postItemToolTip(); ++ this.renderTooltip(p_98590_, list1, p_98591_.m_150921_(), p_98592_, p_98593_, p_98591_); } else { super.m_6057_(p_98590_, p_98591_, p_98592_, p_98593_); } diff --git a/patches/minecraft/net/minecraft/client/gui/screens/inventory/tooltip/ClientTooltipComponent.java.patch b/patches/minecraft/net/minecraft/client/gui/screens/inventory/tooltip/ClientTooltipComponent.java.patch new file mode 100644 index 0000000000..6fce9cd361 --- /dev/null +++ b/patches/minecraft/net/minecraft/client/gui/screens/inventory/tooltip/ClientTooltipComponent.java.patch @@ -0,0 +1,11 @@ +--- a/net/minecraft/client/gui/screens/inventory/tooltip/ClientTooltipComponent.java ++++ b/net/minecraft/client/gui/screens/inventory/tooltip/ClientTooltipComponent.java +@@ -22,6 +_,8 @@ + if (p_169951_ instanceof BundleTooltip) { + return new ClientBundleTooltip((BundleTooltip)p_169951_); + } else { ++ ClientTooltipComponent result = net.minecraftforge.client.MinecraftForgeClient.getClientTooltipComponent(p_169951_); ++ if (result != null) return result; + throw new IllegalArgumentException("Unknown TooltipComponent"); + } + } diff --git a/patches/minecraft/net/minecraft/client/gui/screens/recipebook/RecipeBookPage.java.patch b/patches/minecraft/net/minecraft/client/gui/screens/recipebook/RecipeBookPage.java.patch new file mode 100644 index 0000000000..215f0c4ac8 --- /dev/null +++ b/patches/minecraft/net/minecraft/client/gui/screens/recipebook/RecipeBookPage.java.patch @@ -0,0 +1,11 @@ +--- a/net/minecraft/client/gui/screens/recipebook/RecipeBookPage.java ++++ b/net/minecraft/client/gui/screens/recipebook/RecipeBookPage.java +@@ -115,7 +_,7 @@ + + public void m_100417_(PoseStack p_100418_, int p_100419_, int p_100420_) { + if (this.f_100397_.f_91080_ != null && this.f_100395_ != null && !this.f_100396_.m_100212_()) { +- this.f_100397_.f_91080_.m_96597_(p_100418_, this.f_100395_.m_100477_(this.f_100397_.f_91080_), p_100419_, p_100420_); ++ this.f_100397_.f_91080_.renderComponentTooltip(p_100418_, this.f_100395_.m_100477_(this.f_100397_.f_91080_), p_100419_, p_100420_, this.f_100395_.m_100488_().m_8043_()); + } + + } diff --git a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java index 08914e5aa9..1dc3051ebc 100644 --- a/src/main/java/net/minecraftforge/client/ForgeHooksClient.java +++ b/src/main/java/net/minecraftforge/client/ForgeHooksClient.java @@ -23,7 +23,9 @@ import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.mojang.blaze3d.systems.RenderSystem; import com.mojang.blaze3d.vertex.*; +import com.mojang.datafixers.util.Either; import net.minecraft.client.gui.chat.NarratorChatListener; +import net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent; import net.minecraft.client.gui.screens.multiplayer.JoinMultiplayerScreen; import net.minecraft.client.model.geom.ModelLayerLocation; import net.minecraft.client.model.geom.builders.LayerDefinition; @@ -31,10 +33,13 @@ import net.minecraft.client.multiplayer.ClientLevel; import net.minecraft.client.multiplayer.MultiPlayerGameMode; import net.minecraft.client.multiplayer.ServerData; import net.minecraft.client.player.LocalPlayer; +import net.minecraft.locale.Language; import net.minecraft.network.Connection; +import net.minecraft.network.chat.FormattedText; import net.minecraft.network.chat.TextComponent; import net.minecraft.network.protocol.status.ServerStatus; import net.minecraft.world.effect.MobEffectInstance; +import net.minecraft.world.inventory.tooltip.TooltipComponent; import net.minecraft.world.level.block.state.BlockState; import com.mojang.blaze3d.platform.Window; import net.minecraft.client.Minecraft; @@ -139,6 +144,7 @@ import java.util.Random; import java.util.Set; import java.util.Stack; import java.util.concurrent.atomic.AtomicBoolean; +import java.util.function.Function; import java.util.function.Supplier; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -1073,4 +1079,92 @@ public class ForgeHooksClient }); } } + + public static Font getTooltipFont(@Nullable Font forcedFont, @Nonnull ItemStack stack, Font fallbackFont) + { + if (forcedFont != null) + { + return forcedFont; + } + Font stackFont = RenderProperties.get(stack).getFont(stack); + return stackFont == null ? fallbackFont : stackFont; + } + + public static RenderTooltipEvent.Pre preTooltipEvent(@Nonnull ItemStack stack, PoseStack matrixStack, int x, int y, int screenWidth, int screenHeight, @Nonnull List components, @Nullable Font forcedFont, @Nonnull Font fallbackFont) + { + var preEvent = new RenderTooltipEvent.Pre(stack, matrixStack, x, y, screenWidth, screenHeight, getTooltipFont(forcedFont, stack, fallbackFont), components); + MinecraftForge.EVENT_BUS.post(preEvent); + return preEvent; + } + + public static RenderTooltipEvent.Color colorTooltipEvent(@Nonnull ItemStack stack, PoseStack matrixStack, int x, int y, @Nonnull Font font, @Nonnull List components) + { + var colorEvent = new RenderTooltipEvent.Color(stack, matrixStack, x, y, font, 0xf0100010, 0x505000FF, 0x5028007f, components); + MinecraftForge.EVENT_BUS.post(colorEvent); + return colorEvent; + } + + public static List gatherTooltipComponents(ItemStack stack, List textElements, int mouseX, int screenWidth, int screenHeight, @Nullable Font forcedFont, Font fallbackFont) + { + return gatherTooltipComponents(stack, textElements, Optional.empty(), mouseX, screenWidth, screenHeight, forcedFont, fallbackFont); + } + + public static List gatherTooltipComponents(ItemStack stack, List textElements, Optional itemComponent, int mouseX, int screenWidth, int screenHeight, @Nullable Font forcedFont, Font fallbackFont) + { + Font font = getTooltipFont(forcedFont, stack, fallbackFont); + List> elements = textElements.stream() + .map((Function>) Either::left) + .collect(Collectors.toCollection(ArrayList::new)); + itemComponent.ifPresent(c -> elements.add(Either.right(c))); + + var event = new RenderTooltipEvent.GatherComponents(stack, screenWidth, screenHeight, elements, -1); + MinecraftForge.EVENT_BUS.post(event); + if (event.isCanceled()) return List.of(); + + // text wrapping + int tooltipTextWidth = event.getTooltipElements().stream() + .mapToInt(either -> either.map(font::width, component -> 0)) + .max() + .orElse(0); + + boolean needsWrap = false; + + int tooltipX = mouseX + 12; + if (tooltipX + tooltipTextWidth + 4 > screenWidth) + { + tooltipX = mouseX - 16 - tooltipTextWidth; + if (tooltipX < 4) // if the tooltip doesn't fit on the screen + { + if (mouseX > screenWidth / 2) + tooltipTextWidth = mouseX - 12 - 8; + else + tooltipTextWidth = screenWidth - 16 - mouseX; + needsWrap = true; + } + } + + if (event.getMaxWidth() > 0 && tooltipTextWidth > event.getMaxWidth()) + { + tooltipTextWidth = event.getMaxWidth(); + needsWrap = true; + } + + int tooltipTextWidthF = tooltipTextWidth; + if (needsWrap) + { + return event.getTooltipElements().stream() + .flatMap(either -> either.map( + text -> font.split(text, tooltipTextWidthF).stream().map(ClientTooltipComponent::create), + component -> Stream.of(ClientTooltipComponent.create(component)) + )) + .toList(); + } + return event.getTooltipElements().stream() + .map(either -> either.map( + text -> ClientTooltipComponent.create(text instanceof Component ? ((Component) text).getVisualOrderText() : Language.getInstance().getVisualOrder(text)), + ClientTooltipComponent::create + )) + .toList(); + } + } diff --git a/src/main/java/net/minecraftforge/client/MinecraftForgeClient.java b/src/main/java/net/minecraftforge/client/MinecraftForgeClient.java index cc3bb7240d..91d9ee4146 100644 --- a/src/main/java/net/minecraftforge/client/MinecraftForgeClient.java +++ b/src/main/java/net/minecraftforge/client/MinecraftForgeClient.java @@ -27,12 +27,15 @@ import java.util.Map; import java.util.Optional; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.TimeUnit; +import java.util.function.Function; import java.util.function.Supplier; import javax.annotation.Nonnull; import javax.annotation.Nullable; +import net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent; import net.minecraft.client.renderer.RenderType; +import net.minecraft.world.inventory.tooltip.TooltipComponent; import org.apache.commons.lang3.tuple.Pair; import com.google.common.cache.CacheBuilder; @@ -176,4 +179,24 @@ public class MinecraftForgeClient return textureAtlasSpriteLoaders.get(name); } + private static final Map, Function> tooltipComponentFactories = new ConcurrentHashMap<>(); + + /** + * Register a factory for ClientTooltipComponents. + * @param cls the class for the component + * @param factory the factory for the ClientTooltipComponent + */ + @SuppressWarnings("unchecked") + public static void registerTooltipComponentFactory(Class cls, Function factory) + { + tooltipComponentFactories.put(cls, (Function) factory); + } + + @Nullable + public static ClientTooltipComponent getClientTooltipComponent(TooltipComponent component) + { + var factory = tooltipComponentFactories.get(component.getClass()); + return factory == null ? null : factory.apply(component); + } + } diff --git a/src/main/java/net/minecraftforge/client/event/RenderTooltipEvent.java b/src/main/java/net/minecraftforge/client/event/RenderTooltipEvent.java index 3269576fcd..f5d86eb053 100644 --- a/src/main/java/net/minecraftforge/client/event/RenderTooltipEvent.java +++ b/src/main/java/net/minecraftforge/client/event/RenderTooltipEvent.java @@ -25,9 +25,14 @@ import java.util.List; import javax.annotation.Nonnull; import com.mojang.blaze3d.vertex.PoseStack; +import com.mojang.datafixers.util.Either; import net.minecraft.client.gui.Font; +import net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent; +import net.minecraft.world.inventory.tooltip.TooltipComponent; import net.minecraft.world.item.ItemStack; import net.minecraft.network.chat.FormattedText; +import net.minecraftforge.eventbus.api.Cancelable; +import net.minecraftforge.eventbus.api.Event; /** * A set of events which are fired at various points during tooltip rendering. @@ -45,20 +50,35 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api { @Nonnull protected final ItemStack stack; + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 protected final List lines; - protected final PoseStack matrixStack; + protected final PoseStack matrixStack; // TODO: rename in 1.18 protected int x; protected int y; protected Font fr; + protected final List components; + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public RenderTooltipEvent(@Nonnull ItemStack stack, @Nonnull List lines, PoseStack matrixStack, int x, int y, @Nonnull Font fr) { this.stack = stack; - this.lines = Collections.unmodifiableList(lines); // Leave editing to ItemTooltipEvent + this.lines = Collections.unmodifiableList(lines); this.matrixStack = matrixStack; this.x = x; this.y = y; this.fr = fr; + this.components = List.of(); + } + + public RenderTooltipEvent(@Nonnull ItemStack stack, PoseStack poseStack, int x, int y, @Nonnull Font font, @Nonnull List components) + { + this.stack = stack; + this.lines = List.of(); + this.components = Collections.unmodifiableList(components); + this.matrixStack = poseStack; + this.x = x; + this.y = y; + this.fr = font; } /** @@ -73,14 +93,27 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api /** * The lines to be drawn. May change between {@link RenderTooltipEvent.Pre} and {@link RenderTooltipEvent.Post}. * - * @return An unmodifiable list of strings. Use {@link ItemTooltipEvent} to modify tooltip text. + * @return An unmodifiable list of strings. Use {@link net.minecraftforge.event.entity.player.ItemTooltipEvent} to modify tooltip text. + * @deprecated use {@link #getComponents()} */ @Nonnull + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public List getLines() { return lines; } + /** + * The components to be drawn. + * To modify this list use {@link GatherComponents}. + * @return an unmodifiable list of tooltip components to be drawn. + */ + @Nonnull + public List getComponents() + { + return components; + } + /** * @return The MatrixStack of the current rendering context */ @@ -106,7 +139,7 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api } /** - * @return The {@link FontRenderer} instance the current render is using. + * @return The {@link Font} instance the current render is using. */ @Nonnull public Font getFontRenderer() @@ -114,18 +147,93 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api return fr; } + /** + * Fires when a tooltip gathers the {@link TooltipComponent}s to render. This event fires before any text wrapping + * or text processing. + * This event allows modifying the components to be rendered as well as specifying a maximum width for the tooltip. + * The maximum width will cause any text components to be wrapped. + */ + @Cancelable + public static class GatherComponents extends Event + { + private final ItemStack stack; + private final int screenWidth; + private final int screenHeight; + private final List> tooltipElements; + private int maxWidth; + + public GatherComponents(ItemStack stack, int screenWidth, int screenHeight, List> tooltipElements, int maxWidth) + { + this.stack = stack; + this.screenWidth = screenWidth; + this.screenHeight = screenHeight; + this.tooltipElements = tooltipElements; + this.maxWidth = maxWidth; + } + + /** + * @return the ItemStack whose tooltip is being rendered or an empty stack if this tooltip is not for a stack + */ + public ItemStack getStack() + { + return stack; + } + + /** + * @return the width of the screen + */ + public int getScreenWidth() + { + return screenWidth; + } + + /** + * @return the height of the screen + */ + public int getScreenHeight() + { + return screenHeight; + } + + /** + * The elements to be rendered. These can be either formatted text or custom tooltip components. + * This list is modifiable. + */ + public List> getTooltipElements() + { + return tooltipElements; + } + + /** + * @return the current maximum width for the text components of the tooltip (or -1 for no maximum width) + */ + public int getMaxWidth() + { + return maxWidth; + } + + /** + * Set the maximum width for the text components of the tooltip (or -1 for no maximum width) + */ + public void setMaxWidth(int maxWidth) + { + this.maxWidth = maxWidth; + } + } + /** * This event is fired before any tooltip calculations are done. It provides setters for all aspects of the tooltip, so the final render can be modified. *

* This event is {@link Cancelable}. */ - @net.minecraftforge.eventbus.api.Cancelable + @Cancelable public static class Pre extends RenderTooltipEvent { private int screenWidth; private int screenHeight; private int maxWidth; + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public Pre(@Nonnull ItemStack stack, @Nonnull List lines, PoseStack matrixStack, int x, int y, int screenWidth, int screenHeight, int maxWidth, @Nonnull Font fr) { super(stack, lines, matrixStack, x, y, fr); @@ -134,11 +242,20 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api this.maxWidth = maxWidth; } + public Pre(@Nonnull ItemStack stack, PoseStack matrixStack, int x, int y, int screenWidth, int screenHeight, @Nonnull Font font, @Nonnull List components) + { + super(stack, matrixStack, x, y, font, components); + this.screenWidth = screenWidth; + this.screenHeight = screenHeight; + this.maxWidth = -1; + } + public int getScreenWidth() { return screenWidth; } + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public void setScreenWidth(int screenWidth) { this.screenWidth = screenWidth; @@ -149,6 +266,7 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api return screenHeight; } + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public void setScreenHeight(int screenHeight) { this.screenHeight = screenHeight; @@ -156,7 +274,9 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api /** * @return The max width the tooltip can be. Defaults to -1 (unlimited). + * @deprecated use {@link GatherComponents} */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public int getMaxWidth() { return maxWidth; @@ -164,14 +284,16 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api /** * Sets the max width of the tooltip. Use -1 for unlimited. + * @deprecated use {@link GatherComponents} */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public void setMaxWidth(int maxWidth) { this.maxWidth = maxWidth; } /** - * Sets the {@link FontRenderer} to be used to render text. + * Sets the {@link Font} to be used to render text. */ public void setFontRenderer(@Nonnull Font fr) { @@ -204,6 +326,7 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api *

  • {@link RenderTooltipEvent.PostText}
  • * */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 protected static abstract class Post extends RenderTooltipEvent { private final int width; @@ -236,6 +359,7 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api /** * This event is fired directly after the tooltip background is drawn, but before any text is drawn. */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static class PostBackground extends Post { public PostBackground(@Nonnull ItemStack stack, @Nonnull List textLines, PoseStack matrixStack, int x, int y, @Nonnull Font fr, int width, int height) @@ -245,6 +369,7 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api /** * This event is fired directly after the tooltip text is drawn, but before the GL state is reset. */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static class PostText extends Post { public PostText(@Nonnull ItemStack stack, @Nonnull List textLines, PoseStack matrixStack, int x, int y, @Nonnull Font fr, int width, int height) @@ -259,30 +384,69 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api private final int originalBackground; private final int originalBorderStart; private final int originalBorderEnd; - private int background; + private int backgroundStart; + private int backgroundEnd; private int borderStart; private int borderEnd; - public Color(@Nonnull ItemStack stack, @Nonnull List textLines, PoseStack matrixStack, int x, int y, @Nonnull Font fr, int background, int borderStart, - int borderEnd) + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 + public Color(@Nonnull ItemStack stack, @Nonnull List textLines, PoseStack matrixStack, int x, int y, @Nonnull Font fr, int background, int borderStart, int borderEnd) { super(stack, textLines, matrixStack, x, y, fr); this.originalBackground = background; this.originalBorderStart = borderStart; this.originalBorderEnd = borderEnd; - this.background = background; + this.backgroundStart = background; + this.backgroundEnd = background; this.borderStart = borderStart; this.borderEnd = borderEnd; } + public Color(@Nonnull ItemStack stack, PoseStack matrixStack, int x, int y, @Nonnull Font fr, int background, int borderStart, int borderEnd, @Nonnull List components) + { + super(stack, matrixStack, x, y, fr, components); + this.originalBackground = background; + this.originalBorderStart = borderStart; + this.originalBorderEnd = borderEnd; + this.backgroundStart = background; + this.backgroundEnd = background; + this.borderStart = borderStart; + this.borderEnd = borderEnd; + } + + /** + * @deprecated use {@link #getBackgroundStart()} and {@link #getBackgroundEnd} + */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public int getBackground() { - return background; + return backgroundStart; + } + + public int getBackgroundStart() + { + return backgroundStart; + } + + public int getBackgroundEnd() + { + return backgroundEnd; } public void setBackground(int background) { - this.background = background; + this.backgroundStart = background; + this.backgroundEnd = background; + } + + public void setBackgroundStart(int backgroundStart) + { + this.backgroundStart = backgroundStart; + } + + public void setBackgroundEnd(int backgroundEnd) + { + this.backgroundEnd = backgroundEnd; } public int getBorderStart() @@ -305,11 +469,22 @@ public abstract class RenderTooltipEvent extends net.minecraftforge.eventbus.api this.borderEnd = borderEnd; } + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public int getOriginalBackground() { return originalBackground; } + public int getOriginalBackgroundStart() + { + return originalBackground; + } + + public int getOriginalBackgroundEnd() + { + return originalBackground; + } + public int getOriginalBorderStart() { return originalBorderStart; diff --git a/src/main/java/net/minecraftforge/fmlclient/gui/GuiUtils.java b/src/main/java/net/minecraftforge/fmlclient/gui/GuiUtils.java index b14083669d..a7da2b9b22 100644 --- a/src/main/java/net/minecraftforge/fmlclient/gui/GuiUtils.java +++ b/src/main/java/net/minecraftforge/fmlclient/gui/GuiUtils.java @@ -237,6 +237,7 @@ public class GuiUtils * * @param stack The stack for which a tooltip is about to be drawn. */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void preItemToolTip(@Nonnull ItemStack stack) { cachedTooltipStack = stack; @@ -245,11 +246,13 @@ public class GuiUtils /** * Must be called from {@code GuiScreen.renderToolTip} after {@code GuiScreen.drawHoveringText} is called. */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void postItemToolTip() { cachedTooltipStack = ItemStack.EMPTY; } + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void drawHoveringText(PoseStack mStack, List textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, Font font) { drawHoveringText(mStack, textLines, mouseX, mouseY, screenWidth, screenHeight, maxTextWidth, DEFAULT_BACKGROUND_COLOR, DEFAULT_BORDER_COLOR_START, DEFAULT_BORDER_COLOR_END, font); @@ -274,12 +277,14 @@ public class GuiUtils * between the start and end values. * @param font the font for drawing the text in the tooltip box */ + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void drawHoveringText(PoseStack mStack, List textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, int backgroundColor, int borderColorStart, int borderColorEnd, Font font) { drawHoveringText(cachedTooltipStack, mStack, textLines, mouseX, mouseY, screenWidth, screenHeight, maxTextWidth, backgroundColor, borderColorStart, borderColorEnd, font); } + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void drawHoveringText(@Nonnull final ItemStack stack, PoseStack mStack, List textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, Font font) { drawHoveringText(stack, mStack, textLines, mouseX, mouseY, screenWidth, screenHeight, maxTextWidth, DEFAULT_BACKGROUND_COLOR, DEFAULT_BORDER_COLOR_START, DEFAULT_BORDER_COLOR_END, font); @@ -290,7 +295,7 @@ public class GuiUtils * * @see #drawHoveringText(PoseStack, List, int, int, int, int, int, int, int, int, Font) */ - //TODO, Validate rendering is the same as the original + @Deprecated(since = "1.18", forRemoval = true) // TODO: remove in 1.18 public static void drawHoveringText(@Nonnull final ItemStack stack, PoseStack pStack, List textLines, int mouseX, int mouseY, int screenWidth, int screenHeight, int maxTextWidth, int backgroundColor, int borderColorStart, int borderColorEnd, Font font) diff --git a/src/test/java/net/minecraftforge/debug/client/CustomTooltipTest.java b/src/test/java/net/minecraftforge/debug/client/CustomTooltipTest.java new file mode 100644 index 0000000000..a50c3b41f2 --- /dev/null +++ b/src/test/java/net/minecraftforge/debug/client/CustomTooltipTest.java @@ -0,0 +1,147 @@ +package net.minecraftforge.debug.client; + +import com.mojang.blaze3d.vertex.PoseStack; +import com.mojang.datafixers.util.Either; +import net.minecraft.ChatFormatting; +import net.minecraft.client.gui.Font; +import net.minecraft.client.gui.GuiComponent; +import net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent; +import net.minecraft.client.renderer.entity.ItemRenderer; +import net.minecraft.client.renderer.texture.TextureManager; +import net.minecraft.network.chat.Component; +import net.minecraft.network.chat.TextComponent; +import net.minecraft.world.inventory.tooltip.TooltipComponent; +import net.minecraft.world.item.Item; +import net.minecraft.world.item.ItemStack; +import net.minecraft.world.item.Items; +import net.minecraft.world.item.TooltipFlag; +import net.minecraft.world.level.Level; +import net.minecraftforge.client.MinecraftForgeClient; +import net.minecraftforge.client.event.RenderTooltipEvent; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.eventbus.api.SubscribeEvent; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import net.minecraftforge.fml.loading.FMLEnvironment; +import net.minecraftforge.fmllegacy.RegistryObject; +import net.minecraftforge.registries.DeferredRegister; +import net.minecraftforge.registries.ForgeRegistries; + +import javax.annotation.Nullable; +import java.util.List; +import java.util.Optional; + +@Mod(CustomTooltipTest.ID) +public class CustomTooltipTest +{ + + static final boolean ENABLED = true; + static final String ID = "custom_tooltip_test"; + + private static final DeferredRegister ITEMS = DeferredRegister.create(ForgeRegistries.ITEMS, ID); + static final RegistryObject CUSTOM_ITEM = ITEMS.register("test_item", () -> new CustomItemWithTooltip(new Item.Properties())); + + public CustomTooltipTest() + { + if (ENABLED) { + if (FMLEnvironment.dist.isClient()) + { + MinecraftForge.EVENT_BUS.register(ClientEventHandler.class); + FMLJavaModLoadingContext.get().getModEventBus().register(ClientModBusEventHandler.class); + } + ITEMS.register(FMLJavaModLoadingContext.get().getModEventBus()); + } + } + + static record CustomTooltip(int color) implements TooltipComponent + { + } + + record CustomClientTooltip(CustomTooltip tooltip) implements ClientTooltipComponent + { + + @Override + public int getHeight() + { + return 10; + } + + @Override + public int getWidth(Font font) + { + return 10; + } + + @Override + public void renderImage(Font font, int x, int y, PoseStack poseStack, ItemRenderer itemRenderer_, int zIndex, TextureManager textureManager) + { + GuiComponent.fill(poseStack, x, y, x + 10, y+ 10, tooltip.color); + } + } + + static class CustomItemWithTooltip extends Item + { + public CustomItemWithTooltip(Properties properties) + { + super(properties); + } + + @Override + public void appendHoverText(ItemStack stack, @Nullable Level level, List components, TooltipFlag flag) + { + super.appendHoverText(stack, level, components, flag); + components.add(new TextComponent("This is a very very very very very very long hover text that should really really be split across multiple lines.").withStyle(ChatFormatting.YELLOW)); + } + + @Override + public Optional getTooltipImage(ItemStack stack) + { + return Optional.of(new CustomTooltip(0xFFFF0000)); + } + } + + + private static class ClientModBusEventHandler + { + + @SubscribeEvent + public static void clientSetup(FMLClientSetupEvent event) + { + MinecraftForgeClient.registerTooltipComponentFactory(CustomTooltip.class, CustomClientTooltip::new); + } + + } + + private static class ClientEventHandler + { + + @SubscribeEvent + public static void gatherTooltips(RenderTooltipEvent.GatherComponents event) + { + if (event.getStack().getItem() == Items.STICK) + { + event.getTooltipElements().add(Either.right(new CustomTooltip(0xFF0000FF))); + } + if (event.getStack().getItem() == Items.CLOCK) + { + event.setMaxWidth(30); + } + } + + @SubscribeEvent + public static void preTooltip(RenderTooltipEvent.Color event) + { + if (event.getStack().getItem() == Items.APPLE) + { + event.setBackgroundStart(0xFF0000FF); + event.setBackgroundEnd(0xFFFFFF00); + event.setBorderStart(0xFFFF0000); + event.setBorderEnd(0xFFFF0011); + } + } + + } + + +} diff --git a/src/test/resources/META-INF/mods.toml b/src/test/resources/META-INF/mods.toml index 89f86d09cb..c8e1566b80 100644 --- a/src/test/resources/META-INF/mods.toml +++ b/src/test/resources/META-INF/mods.toml @@ -164,5 +164,7 @@ license="LGPL v2.1" modId="be_onload_test" [[mods]] modId="forge_spawnegg_test" +[[mods]] + modId="custom_tooltip_test" # ADD ABOVE THIS LINE