Refactor how we handle tooltips to make use of minecraft's builtin system:

- Allows properly forwarding element tooltips to EMI
- Make moveable filter buttons properly use the child system so that the tooltips can render for the arrow buttons

Author: pupnewfster

src/generators/java/mekanism/generators/client/gui/GuiFissionReactor.java

@@ -82,19 +82,20 @@ protected void addGuiElements() {
         }));
         activateButton = addRenderableWidget(new TranslationButton(this, 6, 75, 81, 16, GeneratorsLang.FISSION_ACTIVATE,
               (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketGeneratorsGuiInteract(GeneratorsGuiInteraction.FISSION_ACTIVE,
-                    ((GuiFissionReactor) element.gui()).tile, 1)), null, () -> EnumColor.DARK_GREEN) {
+                    ((GuiFissionReactor) element.gui()).tile, 1)), () -> EnumColor.DARK_GREEN) {
             @Override
             public void renderForeground(GuiGraphics guiGraphics, int mouseX, int mouseY) {
                 super.renderForeground(guiGraphics, mouseX, mouseY);
                 if (!active && tile.getMultiblock().isForceDisabled()) {
                     active = true;
                     //Temporarily set active to true, so we can easily check if the mouse is over the button
+                    // Note: We can't just use the delayed tooltip rendering as it doesn't work for inactive buttons
                     if (isMouseOverCheckWindows(mouseX, mouseY)) {
                         PoseStack pose = guiGraphics.pose();
                         pose.pushPose();
                         //Offset to fix rendering position
                         pose.translate(-getGuiLeft(), -getGuiTop(), 0);
-                        displayTooltips(guiGraphics, mouseX, mouseY, GeneratorsLang.FISSION_FORCE_DISABLED.translate());
+                        guiGraphics.renderTooltip(getFont(), GeneratorsLang.FISSION_FORCE_DISABLED.translate(), mouseX, mouseY);
                         pose.popPose();
                     }
                     active = false;
@@ -103,7 +104,7 @@ public void renderForeground(GuiGraphics guiGraphics, int mouseX, int mouseY) {
         });
         scramButton = addRenderableWidget(new TranslationButton(this, 89, 75, 81, 16, GeneratorsLang.FISSION_SCRAM,
               (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketGeneratorsGuiInteract(GeneratorsGuiInteraction.FISSION_ACTIVE,
-                    ((GuiFissionReactor) element.gui()).tile, 0)), null, () -> EnumColor.DARK_RED));
+                    ((GuiFissionReactor) element.gui()).tile, 0)), () -> EnumColor.DARK_RED));
         addRenderableWidget(new GuiBigLight(this, 173, 76, tile.getMultiblock()::isActive));
         addRenderableWidget(new GuiDynamicHorizontalRateBar(this, new IBarInfoHandler() {
             @Override

src/generators/java/mekanism/generators/client/gui/GuiFissionReactorLogicAdapter.java

@@ -35,7 +35,7 @@ protected void addGuiElements() {
         scrollBar = addRenderableWidget(new GuiScrollBar(this, 146, 31, 90, () -> tile.getModes().length, () -> DISPLAY_COUNT));
         for (int i = 0; i < DISPLAY_COUNT; i++) {
             int typeShift = 22 * i;
-            addRenderableWidget(new ReactorLogicButton<>(this, 17, 32 + typeShift, i, tile, scrollBar::getCurrentSelection, tile::getModes, this::changeLogic));
+            addRenderableWidget(new ReactorLogicButton<>(this, 17, 32 + typeShift, i, tile, FissionReactorLogic.class, scrollBar::getCurrentSelection, tile::getModes, this::changeLogic));
         }
     }
 

src/generators/java/mekanism/generators/client/gui/GuiFusionReactorInfo.java

@@ -30,8 +30,8 @@ protected GuiFusionReactorInfo(EmptyTileContainer<TileEntityFusionReactorControl
     protected void addGuiElements() {
         super.addGuiElements();
         addRenderableWidget(new MekanismImageButton(this, 6, 6, 14, getButtonLocation("back"),
-              (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketTileButtonPress(ClickedTileButton.BACK_BUTTON, ((GuiFusionReactorInfo) element.gui()).tile)),
-              (element, graphics, mouseX, mouseY) -> element.displayTooltips(graphics, mouseX, mouseY, MekanismLang.BACK.translate())));
+              (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketTileButtonPress(ClickedTileButton.BACK_BUTTON, ((GuiFusionReactorInfo) element.gui()).tile))))
+              .setTooltip(MekanismLang.BACK);
         addRenderableWidget(new GuiEnergyTab(this, () -> {
             FusionReactorMultiblockData multiblock = tile.getMultiblock();
             return List.of(MekanismLang.STORING.translate(EnergyDisplay.of(multiblock.energyContainer)),

src/generators/java/mekanism/generators/client/gui/GuiFusionReactorLogicAdapter.java

@@ -37,12 +37,12 @@ protected void addGuiElements() {
         super.addGuiElements();
         addRenderableWidget(new GuiElementHolder(this, 16, 31, 130, 90));
         addRenderableWidget(new ToggleButton(this, 16, 19, 11, tile::isActiveCooled,
-              (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketGuiInteract(GuiInteraction.NEXT_MODE, ((GuiFusionReactorLogicAdapter) element.gui()).tile)),
-              (element, graphics, mouseX, mouseY) -> element.displayTooltips(graphics, mouseX, mouseY, GeneratorsLang.REACTOR_LOGIC_TOGGLE_COOLING.translate())));
+              (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketGuiInteract(GuiInteraction.NEXT_MODE, ((GuiFusionReactorLogicAdapter) element.gui()).tile))))
+              .setTooltip(GeneratorsLang.REACTOR_LOGIC_TOGGLE_COOLING);
         scrollBar = addRenderableWidget(new GuiScrollBar(this, 146, 31, 90, () -> tile.getModes().length, () -> DISPLAY_COUNT));
         for (int i = 0; i < DISPLAY_COUNT; i++) {
             int typeShift = 22 * i;
-            addRenderableWidget(new ReactorLogicButton<>(this, 17, 32 + typeShift, i, tile, scrollBar::getCurrentSelection, tile::getModes, this::changeLogic));
+            addRenderableWidget(new ReactorLogicButton<>(this, 17, 32 + typeShift, i, tile, FusionReactorLogic.class, scrollBar::getCurrentSelection, tile::getModes, this::changeLogic));
         }
     }
 

src/generators/java/mekanism/generators/client/gui/GuiIndustrialTurbine.java

@@ -4,7 +4,7 @@
 import java.util.List;
 import mekanism.api.text.EnumColor;
 import mekanism.client.gui.GuiMekanismTile;
-import mekanism.client.gui.element.GuiElement;
+import mekanism.client.gui.MultiLineTooltip;
 import mekanism.client.gui.element.GuiInnerScreen;
 import mekanism.client.gui.element.bar.GuiBar.IBarInfoHandler;
 import mekanism.client.gui.element.bar.GuiVerticalPowerBar;
@@ -16,7 +16,6 @@
 import mekanism.common.MekanismLang;
 import mekanism.common.config.MekanismConfig;
 import mekanism.common.inventory.container.tile.MekanismTileContainer;
-import mekanism.common.tile.TileEntityChemicalTank.GasMode;
 import mekanism.common.util.text.EnergyDisplay;
 import mekanism.common.util.text.TextUtils;
 import mekanism.generators.client.gui.element.GuiTurbineTab;
@@ -110,7 +109,10 @@ public double getLevel() {
             }
             return List.of(MekanismLang.STORING.translate(storing), GeneratorsLang.PRODUCING_AMOUNT.translate(producing));
         }));
-        addRenderableWidget(new GuiGasMode(this, 159, 72, true, () -> tile.getMultiblock().dumpMode, tile.getBlockPos(), 0, this::dumpModeTooltip));
+        Component warning = GeneratorsLang.TURBINE_DUMPING_STEAM_WARNING.translateColored(EnumColor.RED);
+        addRenderableWidget(new GuiGasMode(this, 159, 72, true, () -> tile.getMultiblock().dumpMode, tile.getBlockPos(), 0,
+              MultiLineTooltip.createMulti(GeneratorsLang.TURBINE_DUMPING_EXCESS_STEAM.translate(), warning),
+              MultiLineTooltip.createMulti(GeneratorsLang.TURBINE_DUMPING_STEAM.translate(), warning)));
     }
 
     @Override
@@ -119,12 +121,4 @@ protected void drawForegroundText(@NotNull GuiGraphics guiGraphics, int mouseX,
         drawString(guiGraphics, playerInventoryTitle, inventoryLabelX, inventoryLabelY, titleTextColor());
         super.drawForegroundText(guiGraphics, mouseX, mouseY);
     }
-
-    private void dumpModeTooltip(GuiElement element, GuiGraphics guiGraphics, int mouseX, int mouseY) {
-        GasMode dumpMode = tile.getMultiblock().dumpMode;
-        if (dumpMode != GasMode.IDLE) {
-            GeneratorsLang firstLine = dumpMode == GasMode.DUMPING_EXCESS ? GeneratorsLang.TURBINE_DUMPING_EXCESS_STEAM : GeneratorsLang.TURBINE_DUMPING_STEAM;
-            displayTooltips(guiGraphics, mouseX, mouseY, firstLine.translate(), GeneratorsLang.TURBINE_DUMPING_STEAM_WARNING.translateColored(EnumColor.RED));
-        }
-    }
 }

src/generators/java/mekanism/generators/client/gui/element/button/ReactorLogicButton.java

@@ -1,5 +1,7 @@
 package mekanism.generators.client.gui.element.button;
 
+import java.util.EnumMap;
+import java.util.Map;
 import java.util.function.Consumer;
 import java.util.function.IntSupplier;
 import java.util.function.Supplier;
@@ -13,6 +15,7 @@
 import mekanism.generators.common.base.IReactorLogic;
 import mekanism.generators.common.base.IReactorLogicMode;
 import net.minecraft.client.gui.GuiGraphics;
+import net.minecraft.client.gui.components.Tooltip;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import org.jetbrains.annotations.NotNull;
@@ -25,29 +28,26 @@ public class ReactorLogicButton<TYPE extends Enum<TYPE> & IReactorLogicMode<TYPE
     private final IReactorLogic<TYPE> tile;
     private final int typeOffset;
     private final Supplier<@Nullable TYPE> modeSupplier;
+    private final Map<TYPE, Tooltip> typeTooltips;
     private final Consumer<TYPE> onPress;
 
 
-    public ReactorLogicButton(IGuiWrapper gui, int x, int y, int index, @NotNull IReactorLogic<TYPE> tile, IntSupplier indexSupplier, Supplier<TYPE[]> modeList,
+    public ReactorLogicButton(IGuiWrapper gui, int x, int y, int index, @NotNull IReactorLogic<TYPE> tile, Class<TYPE> clazz, IntSupplier indexSupplier, Supplier<TYPE[]> modeList,
           Consumer<TYPE> onPress) {
-        this(gui, x, y, index, tile, onPress, () -> {
+        this(gui, x, y, index, tile, clazz, onPress, () -> {
             int i = indexSupplier.getAsInt() + index;
             TYPE[] modes = modeList.get();
             return i >= 0 && i < modes.length ? modes[i] : null;
         });
     }
 
-    private ReactorLogicButton(IGuiWrapper gui, int x, int y, int index, @NotNull IReactorLogic<TYPE> tile, Consumer<TYPE> onPress, Supplier<@Nullable TYPE> modeSupplier) {
-        super(gui, x, y, 128, 22, Component.empty(), (element, mouseX, mouseY) -> ((ReactorLogicButton<?>) element).click(), (element, guiGraphics, mouseX, mouseY) -> {
-            IReactorLogicMode<?> mode = ((ReactorLogicButton<?>) element).modeSupplier.get();
-            if (mode != null) {
-                element.displayTooltips(guiGraphics, mouseX, mouseY, mode.getDescription());
-            }
-        });
+    private ReactorLogicButton(IGuiWrapper gui, int x, int y, int index, @NotNull IReactorLogic<TYPE> tile, Class<TYPE> clazz, Consumer<TYPE> onPress, Supplier<@Nullable TYPE> modeSupplier) {
+        super(gui, x, y, 128, 22, Component.empty(), (element, mouseX, mouseY) -> ((ReactorLogicButton<?>) element).click());
         this.onPress = onPress;
         this.typeOffset = 22 * index;
         this.modeSupplier = modeSupplier;
         this.tile = tile;
+        this.typeTooltips = new EnumMap<>(clazz);
     }
 
     private boolean click() {
@@ -77,4 +77,14 @@ public void renderForeground(GuiGraphics guiGraphics, int mouseX, int mouseY) {
             super.renderForeground(guiGraphics, mouseX, mouseY);
         }
     }
+
+    @Override
+    public void updateTooltip(int mouseX, int mouseY) {
+        TYPE mode = modeSupplier.get();
+        if (mode == null) {
+            clearTooltip();
+        } else {
+            setTooltip(typeTooltips.computeIfAbsent(mode, m -> Tooltip.create(m.getDescription())));
+        }
+    }
 }

src/main/java/mekanism/client/gui/GuiDimensionalStabilizer.java

@@ -1,11 +1,13 @@
 package mekanism.client.gui;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import mekanism.api.text.EnumColor;
 import mekanism.client.gui.element.GuiUpArrow;
 import mekanism.client.gui.element.bar.GuiVerticalPowerBar;
 import mekanism.client.gui.element.button.BasicColorButton;
+import mekanism.client.gui.element.button.TooltipColorButton;
 import mekanism.client.gui.element.tab.GuiEnergyTab;
 import mekanism.client.gui.element.tab.GuiVisualsTab;
 import mekanism.common.MekanismLang;
@@ -18,10 +20,12 @@
 import mekanism.common.tile.machine.TileEntityDimensionalStabilizer;
 import mekanism.common.util.text.BooleanStateDisplay.OnOff;
 import net.minecraft.client.gui.GuiGraphics;
+import net.minecraft.client.gui.components.Tooltip;
 import net.minecraft.core.SectionPos;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.entity.player.Inventory;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public class GuiDimensionalStabilizer extends GuiMekanismTile<TileEntityDimensionalStabilizer, MekanismTileContainer<TileEntityDimensionalStabilizer>> {
 
@@ -50,7 +54,7 @@ protected void addGuiElements() {
                 int shiftedZ = z + TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS;
                 int chunkZ = tileChunkZ + z;
                 if (x == 0 && z == 0) {
-                    addRenderableWidget(BasicColorButton.renderActive(this, 63 + 10 * shiftedX, 19 + 10 * shiftedZ, 10, EnumColor.DARK_BLUE, (element, mouseX, mouseY) -> {
+                    addRenderableWidget(new BasicColorButton(this, 63 + 10 * shiftedX, 19 + 10 * shiftedZ, 10, () -> EnumColor.DARK_BLUE, (element, mouseX, mouseY) -> {
                         for (int i = 1; i <= TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS; i++) {
                             if (hasAtRadius(i, false)) {
                                 return PacketUtils.sendToServer(new PacketGuiInteract(GuiInteraction.ENABLE_RADIUS_CHUNKLOAD, tile, i));
@@ -64,39 +68,49 @@ protected void addGuiElements() {
                             }
                         }
                         return false;
-                    }, (onHover, guiGraphics, mouseX, mouseY) -> {
-                        List<Component> tooltips = new ArrayList<>();
-                        tooltips.add(MekanismLang.STABILIZER_CENTER.translate(EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
-                        //TODO: Can we eventually optimize this further such as if we know that we have 1 enabled as we are enabling either radius 2 or "3" (nothing)
-                        // then even if nothing is enabled at radius 2 currently, we don't have to check radius 1 to know that we should display the text for disabling it
-                        // for now it doesn't really matter as given we only support a radius of two it only checks at most the inner radius (8 extra boolean lookups)
-                        for (int i = 1; i <= TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS; i++) {
-                            if (hasAtRadius(i, false)) {
-                                //Add an empty line for readability. Must be done by adding a string that just renders a space
-                                tooltips.add(Component.literal(" "));
-                                tooltips.add(MekanismLang.STABILIZER_ENABLE_RADIUS.translate(EnumColor.INDIGO, i, EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
-                                break;
+                    }) {
+                        private List<Component> lastInfo = Collections.emptyList();
+                        @Nullable
+                        private Tooltip lastTooltip;
+
+                        @Override
+                        public void updateTooltip(int mouseX, int mouseY) {
+                            List<Component> tooltips = new ArrayList<>();
+                            tooltips.add(MekanismLang.STABILIZER_CENTER.translate(EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
+                            //TODO: Can we eventually optimize this further such as if we know that we have 1 enabled as we are enabling either radius 2 or "3" (nothing)
+                            // then even if nothing is enabled at radius 2 currently, we don't have to check radius 1 to know that we should display the text for disabling it
+                            // for now it doesn't really matter as given we only support a radius of two it only checks at most the inner radius (8 extra boolean lookups)
+                            for (int i = 1; i <= TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS; i++) {
+                                if (hasAtRadius(i, false)) {
+                                    //Add an empty line for readability. Must be done by adding a string that just renders a space
+                                    tooltips.add(Component.literal(" "));
+                                    tooltips.add(MekanismLang.STABILIZER_ENABLE_RADIUS.translate(EnumColor.INDIGO, i, EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
+                                    break;
+                                }
                             }
-                        }
-                        for (int i = TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS; i > 0; i--) {
-                            if (hasAtRadius(i, true)) {
-                                //Add an empty line for readability. Must be done by adding a string that just renders a space
-                                tooltips.add(Component.literal(" "));
-                                tooltips.add(MekanismLang.STABILIZER_DISABLE_RADIUS.translate(EnumColor.INDIGO, i, EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
-                                break;
+                            for (int i = TileEntityDimensionalStabilizer.MAX_LOAD_RADIUS; i > 0; i--) {
+                                if (hasAtRadius(i, true)) {
+                                    //Add an empty line for readability. Must be done by adding a string that just renders a space
+                                    tooltips.add(Component.literal(" "));
+                                    tooltips.add(MekanismLang.STABILIZER_DISABLE_RADIUS.translate(EnumColor.INDIGO, i, EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ));
+                                    break;
+                                }
+                            }
+                            if (!tooltips.equals(lastInfo)) {
+                                lastInfo = tooltips;
+                                lastTooltip = MultiLineTooltip.createMulti(tooltips);
                             }
+                            setTooltip(lastTooltip);
                         }
-                        onHover.displayTooltips(guiGraphics, mouseX, mouseY, tooltips);
-                    }));
+                    });
                 } else {
                     int packetTarget = shiftedX * TileEntityDimensionalStabilizer.MAX_LOAD_DIAMETER + shiftedZ;
-                    addRenderableWidget(BasicColorButton.toggle(this, 63 + 10 * shiftedX, 19 + 10 * shiftedZ, 10, EnumColor.DARK_BLUE,
+                    addRenderableWidget(new TooltipColorButton(this, 63 + 10 * shiftedX, 19 + 10 * shiftedZ, 10, EnumColor.DARK_BLUE,
                           () -> tile.isChunkLoadingAt(shiftedX, shiftedZ),
                           (element, mouseX, mouseY) -> PacketUtils.sendToServer(new PacketGuiInteract(GuiInteraction.TOGGLE_CHUNKLOAD, tile, packetTarget)),
-                          (element, graphics, mouseX, mouseY) -> element.displayTooltips(graphics, mouseX, mouseY,
-                                MekanismLang.STABILIZER_TOGGLE_LOADING.translate(OnOff.of(tile.isChunkLoadingAt(shiftedX, shiftedZ), true),
-                                EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ)
-                          )));
+                          MekanismLang.STABILIZER_TOGGLE_LOADING.translate(OnOff.of(true, true), EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ),
+                          MekanismLang.STABILIZER_TOGGLE_LOADING.translate(OnOff.of(false, true), EnumColor.INDIGO, chunkX, EnumColor.INDIGO, chunkZ)
+                    ));
                 }
             }
         }