Add data-driven tooltips about better RLC assembler yield (#1050)

Author: Technici4n

src/generated/resources/assets/modern_industrialization/lang/en_us.json

@@ -1595,6 +1595,7 @@
   "text.modern_industrialization.GunpowderTime": "Overclock: %s",
   "text.modern_industrialization.GunpowderUpgrade": "Double MI Steam Machines speed for 2 minutes",
   "text.modern_industrialization.GunpowderUpgradeMachine": "Use Gunpowder to double this machine speed for 2 minutes",
+  "text.modern_industrialization.HasBetterYieldAssemblerRecipe": "Has an Assembler recipe with better yield.",
   "text.modern_industrialization.HeatConduction": "Heat Conduction %s/°kCt",
   "text.modern_industrialization.ItemAutoExtractOff": "Item auto-eject disabled",
   "text.modern_industrialization.ItemAutoExtractOn": "Item auto-eject enabled",

src/generated/resources/data/modern_industrialization/data_maps/item/item_tooltips.json

@@ -0,0 +1,31 @@
+{
+  "values": {
+    "modern_industrialization:capacitor": {
+      "components": [
+        {
+          "color": "#A9A9A9",
+          "italic": false,
+          "translate": "text.modern_industrialization.HasBetterYieldAssemblerRecipe"
+        }
+      ]
+    },
+    "modern_industrialization:inductor": {
+      "components": [
+        {
+          "color": "#A9A9A9",
+          "italic": false,
+          "translate": "text.modern_industrialization.HasBetterYieldAssemblerRecipe"
+        }
+      ]
+    },
+    "modern_industrialization:resistor": {
+      "components": [
+        {
+          "color": "#A9A9A9",
+          "italic": false,
+          "translate": "text.modern_industrialization.HasBetterYieldAssemblerRecipe"
+        }
+      ]
+    }
+  }
+}

src/main/java/aztech/modern_industrialization/MI.java

@@ -217,6 +217,7 @@ public MI(IEventBus modBus, Dist dist) {
             event.register(MIDataMaps.FLUID_FUELS);
             event.register(MIDataMaps.ITEM_PIPE_UPGRADES);
             event.register(MIDataMaps.MACHINE_UPGRADES);
+            event.register(MIDataMaps.ITEM_TOOLTIPS);
         });
 
         if (MIConfig.loadAe2Compat()) {

src/main/java/aztech/modern_industrialization/MIText.java

@@ -141,6 +141,7 @@ public enum MIText {
     GunpowderTime("Overclock: %s"),
     GunpowderUpgrade("Double MI Steam Machines speed for 2 minutes"),
     GunpowderUpgradeMachine("Use Gunpowder to double this machine speed for 2 minutes"),
+    HasBetterYieldAssemblerRecipe("Has an Assembler recipe with better yield."),
     HeatConduction("Heat Conduction %s/°kCt"),
     ItemAutoExtractOff("Item auto-eject disabled"),
     ItemAutoExtractOn("Item auto-eject enabled"),

src/main/java/aztech/modern_industrialization/MITooltips.java

@@ -97,20 +97,16 @@ public static Style styleFromProgress(double progress, boolean zeroIsGreen) {
     }
 
     public static void attachTooltip(ItemStack stack, List<Component> lines) {
-        Item item = stack.getItem();
-        if (item != null) {
-            boolean hasPrintRequiredShift = false;
-            for (var tooltip : TOOLTIPS) {
-                Optional<List<? extends Component>> maybeComponents = tooltip.tooltipLines.apply(stack, stack.getItem());
-                if (!tooltip.requiresShift || CommonProxy.INSTANCE.hasShiftDown()) {
-                    maybeComponents.ifPresent(lines::addAll);
-                } else if (tooltip.requiresShift && !hasPrintRequiredShift) {
-                    if (maybeComponents.isPresent()) {
-                        lines.add(MIText.TooltipsShiftRequired.text().setStyle(DEFAULT_STYLE));
-                        hasPrintRequiredShift = true;
-                    }
+        boolean hasPrintRequiredShift = false;
+        for (var tooltip : TOOLTIPS) {
+            Optional<List<? extends Component>> maybeComponents = tooltip.tooltipLines.apply(stack, stack.getItem());
+            if (!tooltip.requiresShift || CommonProxy.INSTANCE.hasShiftDown()) {
+                maybeComponents.ifPresent(lines::addAll);
+            } else if (tooltip.requiresShift && !hasPrintRequiredShift) {
+                if (maybeComponents.isPresent()) {
+                    lines.add(MIText.TooltipsShiftRequired.text().setStyle(DEFAULT_STYLE));
+                    hasPrintRequiredShift = true;
                 }
-
             }
         }
     }
@@ -212,6 +208,16 @@ public Component parse(Double ratio) {
 
     public static final Parser<Component> COMPONENT = state -> state;
 
+    // Data-driven tooltips
+    public static final TooltipAttachment DATA_DRIVEN = TooltipAttachment.ofMultilines((stack, item) -> {
+        var dataMap = stack.getItemHolder().getData(MIDataMaps.ITEM_TOOLTIPS);
+        if (dataMap != null) {
+            return Optional.of(dataMap.components());
+        } else {
+            return Optional.empty();
+        }
+    }).setPriority(-100);
+
     // Tooltips
 
     public static final TooltipAttachment BATTERIES = TooltipAttachment.of(

src/main/java/aztech/modern_industrialization/api/datamaps/ItemTooltip.java

@@ -0,0 +1,39 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Azercoco & Technici4n
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package aztech.modern_industrialization.api.datamaps;
+
+import com.mojang.serialization.Codec;
+import com.mojang.serialization.codecs.RecordCodecBuilder;
+import java.util.List;
+import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentSerialization;
+
+public record ItemTooltip(List<Component> components) {
+    public static final Codec<ItemTooltip> CODEC = RecordCodecBuilder.create(
+            instance -> instance
+                    .group(
+                            ComponentSerialization.CODEC.listOf(1, Integer.MAX_VALUE).fieldOf("components")
+                                    .forGetter(ItemTooltip::components))
+                    .apply(instance, ItemTooltip::new));
+}

src/main/java/aztech/modern_industrialization/api/datamaps/MIDataMaps.java

@@ -24,10 +24,13 @@
 package aztech.modern_industrialization.api.datamaps;
 
 import aztech.modern_industrialization.MI;
+import java.util.ArrayList;
 import net.minecraft.core.registries.Registries;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.level.material.Fluid;
+import net.neoforged.neoforge.registries.datamaps.AdvancedDataMapType;
 import net.neoforged.neoforge.registries.datamaps.DataMapType;
+import net.neoforged.neoforge.registries.datamaps.DataMapValueRemover;
 
 public final class MIDataMaps {
     public static final DataMapType<Fluid, FluidFuel> FLUID_FUELS = DataMapType
@@ -54,6 +57,21 @@ public final class MIDataMaps {
             .synced(MachineUpgrade.CODEC, true)
             .build();
 
+    /**
+     * Allows attaching a tooltip to arbitrary items.
+     */
+    public static final AdvancedDataMapType<Item, ItemTooltip, DataMapValueRemover.Default<ItemTooltip, Item>> ITEM_TOOLTIPS = AdvancedDataMapType
+            .builder(
+                    MI.id("item_tooltips"), Registries.ITEM, ItemTooltip.CODEC)
+            .synced(ItemTooltip.CODEC, true)
+            .remover(DataMapValueRemover.Default.codec())
+            .merger((registry, first, firstValue, second, secondValue) -> {
+                var components = new ArrayList<>(firstValue.components());
+                components.addAll(secondValue.components());
+                return new ItemTooltip(components);
+            })
+            .build();
+
     private MIDataMaps() {
     }
 }

src/main/java/aztech/modern_industrialization/datagen/datamap/MIDataMapProvider.java

@@ -27,13 +27,17 @@
 import aztech.modern_industrialization.MIFluids;
 import aztech.modern_industrialization.MIItem;
 import aztech.modern_industrialization.MIRegistries;
+import aztech.modern_industrialization.MIText;
+import aztech.modern_industrialization.MITooltips;
 import aztech.modern_industrialization.api.datamaps.FluidFuel;
 import aztech.modern_industrialization.api.datamaps.ItemPipeUpgrade;
+import aztech.modern_industrialization.api.datamaps.ItemTooltip;
 import aztech.modern_industrialization.api.datamaps.MIDataMaps;
 import aztech.modern_industrialization.api.datamaps.MachineUpgrade;
 import aztech.modern_industrialization.datagen.loot.MILootTables;
 import aztech.modern_industrialization.definition.FluidDefinition;
 import aztech.modern_industrialization.definition.ItemDefinition;
+import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import net.minecraft.core.HolderLookup;
 import net.minecraft.data.PackOutput;
@@ -56,6 +60,7 @@ protected void gather() {
         gatherFluidFuels();
         gatherItemPipeUpgrades();
         gatherMachineUpgrades();
+        gatherItemTooltips();
 
         builder(NeoForgeDataMaps.RAID_HERO_GIFTS)
                 .add(MIRegistries.INDUSTRIALIST, new RaidHeroGift(MILootTables.INDUSTRIALIST_GIFT), false);
@@ -125,4 +130,15 @@ private void gatherMachineUpgrades() {
     private void addMachineUpgrade(ItemDefinition<?> itemDefinition, int extraMaxEu) {
         builder(MIDataMaps.MACHINE_UPGRADES).add(itemDefinition.getId(), new MachineUpgrade(extraMaxEu), false);
     }
+
+    private void gatherItemTooltips() {
+        addItemTooltip("capacitor", MIText.HasBetterYieldAssemblerRecipe);
+        addItemTooltip("inductor", MIText.HasBetterYieldAssemblerRecipe);
+        addItemTooltip("resistor", MIText.HasBetterYieldAssemblerRecipe);
+    }
+
+    private void addItemTooltip(String path, MIText text) {
+        var component = text.text().setStyle(MITooltips.DEFAULT_STYLE);
+        builder(MIDataMaps.ITEM_TOOLTIPS).add(MI.id(path), new ItemTooltip(List.of(component)), false);
+    }
 }