tag all builtin tooltips

Note that the tags are not guaranteed to be stable as API classes do. This is more of workaround to allow plugins to override builtin tooltips.

Author: deirn

src/api/java/mcp/mobius/waila/api/WailaConstants.java

@@ -50,6 +50,13 @@ public class WailaConstants {
      */
     public static final ResourceLocation MOD_NAME_TAG = id("mod_name");
 
+    /**
+     * Tooltip tag for errors.
+     *
+     * @see ITooltip#setLine
+     */
+    public static final ResourceLocation ERROR_TAG = id("error");
+
     /**
      * Whether Waila should show tooltip for blocks.
      * <p>

src/main/java/mcp/mobius/waila/util/ExceptionUtil.java

@@ -4,6 +4,7 @@
 import java.util.Set;
 
 import mcp.mobius.waila.api.ITooltip;
+import mcp.mobius.waila.api.WailaConstants;
 import net.minecraft.ChatFormatting;
 import net.minecraft.network.chat.Component;
 import org.apache.commons.lang3.exception.ExceptionUtils;
@@ -23,8 +24,9 @@ public static boolean dump(Throwable e, String errorName, @Nullable ITooltip too
         }
 
         if (tooltip != null) {
-            tooltip.addLine(Component.literal("Error on " + errorName).withStyle(ChatFormatting.RED));
-            tooltip.addLine(Component.literal("See logs for more info").withStyle(ChatFormatting.RED));
+            tooltip.setLine(WailaConstants.ERROR_TAG, Component
+                .literal("Error on " + errorName + "\nSee logs for more info")
+                .withStyle(ChatFormatting.RED));
         }
 
         return log;

src/pluginExtra/java/mcp/mobius/waila/plugin/extra/provider/FluidProvider.java

@@ -12,6 +12,7 @@
 import mcp.mobius.waila.api.data.FluidData;
 import mcp.mobius.waila.api.util.WNumbers;
 import mcp.mobius.waila.plugin.extra.data.FluidDataImpl;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.level.block.Block;
@@ -64,7 +65,7 @@ private void addFluidTooltip(ITooltip tooltip, FluidDataImpl data, IPluginConfig
             text += " " + displayUnit.symbol;
 
             var sprite = desc.sprite();
-            tooltip.addLine(new PairComponent(
+            tooltip.setLine(FluidData.ID.withSuffix("." + BuiltInRegistries.FLUID.getKey(entry.fluid()).toLanguageKey()), new PairComponent(
                 new WrappedComponent(desc.name().getString()),
                 new SpriteBarComponent(ratio, sprite, 16, 16, desc.tint(), Component.literal(text))));
         }

src/pluginHarvest/java/mcp/mobius/waila/plugin/harvest/provider/HarvestProvider.java

@@ -26,6 +26,7 @@
 import net.minecraft.client.resources.language.I18n;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.MutableComponent;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.block.state.BlockState;
 import org.jetbrains.annotations.NotNull;
@@ -34,6 +35,12 @@ public enum HarvestProvider implements IBlockComponentProvider, IEventListener {
 
     INSTANCE;
 
+    private static final ResourceLocation CLASSIC_HARVESTABLE = Options.rl("classic.harvestable");
+    private static final ResourceLocation CLASSIC_EFFECTIVE_TOOL = Options.rl("classic.effective_tool");
+    private static final ResourceLocation CLASSIC_LEVEL = Options.rl("classic.level");
+
+    private static final ResourceLocation CLASSIC_MINIMAL = Options.rl("classic.minimal");
+
     private static final ToolType UNBREAKABLE = new ToolType();
 
     public final Map<BlockState, List<ToolType>> toolsCache = new Reference2ObjectOpenHashMap<>();
@@ -94,16 +101,16 @@ public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig
         var heldStack = accessor.getPlayer().getInventory().getSelected();
 
         if (displayMode == HarvestDisplayMode.CLASSIC) {
-            tooltip.addLine(Component.empty()
+            tooltip.setLine(CLASSIC_HARVESTABLE, Component.empty()
                 .append(getHarvestableSymbol(accessor, unbreakable))
                 .append(" ")
                 .append(Component.translatable(Tl.Tooltip.Harvest.HARVESTABLE)));
 
-            if (!tools.isEmpty() && !unbreakable) tooltip.addLine(new PairComponent(
+            if (!tools.isEmpty() && !unbreakable) tooltip.setLine(CLASSIC_EFFECTIVE_TOOL, new PairComponent(
                 Component.translatable(Tl.Tooltip.Harvest.EFFECTIVE_TOOL),
                 getToolText(tools, heldStack)));
 
-            if (highestTier != ToolTier.NONE) tooltip.addLine(new PairComponent(
+            if (highestTier != ToolTier.NONE) tooltip.setLine(CLASSIC_LEVEL, new PairComponent(
                 Component.translatable(Tl.Tooltip.Harvest.LEVEL),
                 getTierText(highestTier, heldStack)));
         } else if (displayMode == HarvestDisplayMode.CLASSIC_MINIMAL) {
@@ -121,7 +128,7 @@ public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig
                 text.append(getTierText(highestTier, heldStack));
             }
 
-            tooltip.addLine(text);
+            tooltip.setLine(CLASSIC_MINIMAL, text);
         }
     }
 

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/BeaconProvider.java

@@ -7,6 +7,7 @@
 import mcp.mobius.waila.plugin.vanilla.config.Options;
 import mcp.mobius.waila.plugin.vanilla.provider.data.BeaconDataProvider;
 import net.minecraft.core.Holder;
+import net.minecraft.network.chat.CommonComponents;
 import net.minecraft.network.chat.MutableComponent;
 import net.minecraft.world.effect.MobEffect;
 
@@ -23,17 +24,16 @@ public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig
         if (!config.getBoolean(Options.EFFECT_BEACON)) return;
 
         var data = accessor.getData().get(BeaconDataProvider.DATA);
-        if (data == null) return;
+        if (data == null || data.primary() == null) return;
 
-        if (data.primary() != null) {
-            var text = getText(data.primary());
-            if (data.primary() == data.secondary()) text.append(" II");
-            tooltip.addLine(text);
-        }
+        var text = getText(data.primary());
+        if (data.primary() == data.secondary()) text.append(" II");
 
         if (data.secondary() != null && data.primary() != data.secondary()) {
-            tooltip.addLine(getText(data.secondary()));
+            text.append(CommonComponents.NEW_LINE).append(getText(data.secondary()));
         }
+
+        tooltip.setLine(Options.EFFECT_BEACON, text);
     }
 
 }

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/BeeProvider.java

@@ -20,7 +20,7 @@ public enum BeeProvider implements IEntityComponentProvider {
     public void appendBody(ITooltip tooltip, IEntityAccessor accessor, IPluginConfig config) {
         var hivePos = accessor.getData().get(BeeDataProvider.HIVE_POS);
         if (hivePos != null && config.getBoolean(Options.BEE_HIVE_POS)) {
-            tooltip.addLine(new PairComponent(
+            tooltip.setLine(Options.BEE_HIVE_POS, new PairComponent(
                 new WrappedComponent(Component.translatable(Tl.Tooltip.Bee.HIVE)),
                 new PositionComponent(hivePos.pos())));
         }

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/BeehiveProvider.java

@@ -9,6 +9,7 @@
 import mcp.mobius.waila.buildconst.Tl;
 import mcp.mobius.waila.plugin.vanilla.config.Options;
 import mcp.mobius.waila.plugin.vanilla.provider.data.BeehiveDataProvider;
+import net.minecraft.network.chat.CommonComponents;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.level.block.BeehiveBlock;
 
@@ -33,17 +34,24 @@ public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig
                 names.put(name, names.getOrDefault(name, 0) + 1);
             }
 
-            for (var entry : names.object2IntEntrySet()) {
-                var name = entry.getKey();
-                var count = entry.getIntValue();
-                if (count > 1) tooltip.addLine(Component.literal(count + " " + name));
-                else tooltip.addLine(Component.literal(name));
+            if (!names.isEmpty()) {
+                var component = Component.empty();
+
+                for (var entry : names.object2IntEntrySet()) {
+                    if (!component.getSiblings().isEmpty()) component.append(CommonComponents.NEW_LINE);
+                    var name = entry.getKey();
+                    var count = entry.getIntValue();
+                    if (count > 1) component.append(Component.literal(count + " " + name));
+                    else component.append(Component.literal(name));
+                }
+
+                tooltip.setLine(Options.BEE_HIVE_OCCUPANTS, component);
             }
         }
 
         if (config.getBoolean(Options.BEE_HIVE_HONEY_LEVEL)) {
             var state = accessor.getBlockState();
-            tooltip.addLine(new PairComponent(
+            tooltip.setLine(Options.BEE_HIVE_HONEY_LEVEL, new PairComponent(
                 Component.translatable(Tl.Tooltip.HONEY_LEVEL),
                 Component.literal(state.getValue(BeehiveBlock.HONEY_LEVEL).toString())));
         }

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/BlockAttributesProvider.java

@@ -18,19 +18,20 @@ public enum BlockAttributesProvider implements IBlockComponentProvider {
     @Override
     public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig config) {
         if (config.getBoolean(Options.BLOCK_POSITION)) {
-            tooltip.addLine(new PositionComponent(accessor.getPosition()));
+            tooltip.setLine(Options.BLOCK_POSITION, new PositionComponent(accessor.getPosition()));
         }
 
         if (config.getBoolean(Options.BLOCK_STATE)) {
             var state = accessor.getBlockState();
-            state.getProperties().forEach(property -> {
-                Comparable<?> value = state.getValue(property);
+            for (var property : state.getProperties()) {
+                var value = state.getValue(property);
                 var valueText = Component.literal(value.toString());
                 if (property instanceof BooleanProperty) {
                     valueText.withStyle(value == Boolean.TRUE ? ChatFormatting.GREEN : ChatFormatting.RED);
                 }
-                tooltip.addLine(new PairComponent(Component.literal(property.getName()), valueText));
-            });
+                var name = property.getName();
+                tooltip.setLine(Options.BLOCK_STATE.withSuffix("." + name), new PairComponent(Component.literal(name), valueText));
+            }
         }
     }
 

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/BreakProgressProvider.java

@@ -47,7 +47,7 @@ public void onAfterTooltipRender(GuiGraphics ctx, Rectangle rect, ICommonAccesso
         var progressChangeAmount = progressDiff * dt;
         var actualProgress = Mth.clamp(lastProgress + progressChangeAmount, 0f, 1f);
 
-        final float[] lineLength = new float[1];
+        final var lineLength = new float[1];
 
         if (config.getBoolean(Options.BREAKING_PROGRESS_BOTTOM_ONLY)) {
             lineLength[0] = (rect.width - 2) * actualProgress;

src/pluginVanilla/java/mcp/mobius/waila/plugin/vanilla/provider/ComposterProvider.java

@@ -18,7 +18,7 @@ public enum ComposterProvider implements IBlockComponentProvider {
     public void appendBody(ITooltip tooltip, IBlockAccessor accessor, IPluginConfig config) {
         if (config.getBoolean(Options.LEVEL_COMPOSTER)) {
             var state = accessor.getBlockState();
-            tooltip.addLine(new PairComponent(
+            tooltip.setLine(Options.LEVEL_COMPOSTER, new PairComponent(
                 Component.translatable(Tl.Tooltip.COMPOST_LEVEL),
                 Component.literal(state.getValue(ComposterBlock.LEVEL).toString())));
         }