Use components for upgrade adjectives

This makes quick-and-dirty datapacks a little easier, as you can now use
a hard-coded string rather than adding a language key.

projects/common-api/src/main/java/dan200/computercraft/api/pocket/AbstractPocketUpgrade.java

@@ -4,6 +4,7 @@
 
 package dan200.computercraft.api.pocket;
 
+import net.minecraft.network.chat.Component;
 import net.minecraft.world.item.ItemStack;
 
 
@@ -13,16 +14,20 @@
  * One does not have to use this, but it does provide a convenient template.
  */
 public abstract class AbstractPocketUpgrade implements IPocketUpgrade {
-    private final String adjective;
+    private final Component adjective;
     private final ItemStack stack;
 
-    protected AbstractPocketUpgrade(String adjective, ItemStack stack) {
+    protected AbstractPocketUpgrade(Component adjective, ItemStack stack) {
         this.adjective = adjective;
         this.stack = stack;
     }
 
+    protected AbstractPocketUpgrade(String adjective, ItemStack stack) {
+        this(Component.translatable(adjective), stack);
+    }
+
     @Override
-    public final String getUnlocalisedAdjective() {
+    public final Component getAdjective() {
         return adjective;
     }
 

projects/common-api/src/main/java/dan200/computercraft/api/turtle/AbstractTurtleUpgrade.java

@@ -4,6 +4,7 @@
 
 package dan200.computercraft.api.turtle;
 
+import net.minecraft.network.chat.Component;
 import net.minecraft.world.item.ItemStack;
 
 
@@ -14,17 +15,21 @@
  */
 public abstract class AbstractTurtleUpgrade implements ITurtleUpgrade {
     private final TurtleUpgradeType type;
-    private final String adjective;
+    private final Component adjective;
     private final ItemStack stack;
 
-    protected AbstractTurtleUpgrade(TurtleUpgradeType type, String adjective, ItemStack stack) {
+    protected AbstractTurtleUpgrade(TurtleUpgradeType type, Component adjective, ItemStack stack) {
         this.type = type;
         this.adjective = adjective;
         this.stack = stack;
     }
 
+    protected AbstractTurtleUpgrade(TurtleUpgradeType type, String adjective, ItemStack stack) {
+        this(type, Component.translatable(adjective), stack);
+    }
+
     @Override
-    public final String getUnlocalisedAdjective() {
+    public final Component getAdjective() {
         return adjective;
     }
 

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleUpgradeDataProvider.java

@@ -13,6 +13,7 @@
 import net.minecraft.core.component.DataComponents;
 import net.minecraft.data.DataGenerator;
 import net.minecraft.data.PackOutput;
+import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.tags.TagKey;
 import net.minecraft.world.entity.ai.attributes.Attributes;
@@ -58,7 +59,7 @@ public final ToolBuilder tool(ResourceLocation id, Item item) {
     public final class ToolBuilder {
         private final ResourceLocation id;
         private final Item toolItem;
-        private String adjective;
+        private Component adjective;
         private @Nullable Item craftingItem;
         private float damageMultiplier = TurtleToolSpec.DEFAULT_DAMAGE_MULTIPLIER;
         private @Nullable TagKey<Block> breakable;
@@ -67,7 +68,7 @@ public final class ToolBuilder {
 
         ToolBuilder(ResourceLocation id, Item toolItem) {
             this.id = id;
-            adjective = UpgradeBase.getDefaultAdjective(id);
+            adjective = Component.translatable(UpgradeBase.getDefaultAdjective(id));
             this.toolItem = toolItem;
             craftingItem = null;
         }
@@ -78,7 +79,7 @@ public final class ToolBuilder {
          * @param adjective The new adjective to use.
          * @return The tool builder, for further use.
          */
-        public ToolBuilder adjective(String adjective) {
+        public ToolBuilder adjective(Component adjective) {
             this.adjective = adjective;
             return this;
         }

projects/common-api/src/main/java/dan200/computercraft/api/upgrades/UpgradeBase.java

@@ -11,6 +11,7 @@
 import dan200.computercraft.api.turtle.TurtleSide;
 import net.minecraft.Util;
 import net.minecraft.core.component.DataComponentPatch;
+import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.ItemStack;
 
@@ -26,13 +27,16 @@ public interface UpgradeBase {
     UpgradeType<?> getType();
 
     /**
-     * Return an unlocalised string to describe this type of computer in item names.
+     * A description of this upgrade for use in item names.
+     * <p>
+     * This should typically be a {@linkplain Component#translatable(String) translation key}, rather than a hard coded
+     * string.
      * <p>
      * Examples of built-in adjectives are "Wireless", "Mining" and "Crafty".
      *
-     * @return The localisation key for this upgrade's adjective.
+     * @return The text component for this upgrade's adjective.
      */
-    String getUnlocalisedAdjective();
+    Component getAdjective();
 
     /**
      * Return an item stack representing the type of item that a computer must be crafted
@@ -107,7 +111,7 @@ default boolean isItemSuitable(ItemStack stack) {
      *
      * @param id The upgrade ID.
      * @return The  generated adjective.
-     * @see #getUnlocalisedAdjective()
+     * @see #getAdjective()
      */
     static String getDefaultAdjective(ResourceLocation id) {
         return Util.makeDescriptionId("upgrade", id) + ".adjective";

projects/common-api/src/main/java/dan200/computercraft/impl/upgrades/TurtleToolSpec.java

@@ -10,6 +10,8 @@
 import dan200.computercraft.api.turtle.TurtleToolDurability;
 import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.core.registries.Registries;
+import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentSerialization;
 import net.minecraft.tags.TagKey;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.level.block.Block;
@@ -28,7 +30,7 @@
  * @param breakable         The items breakable by this tool.
  */
 public record TurtleToolSpec(
-    String adjective,
+    Component adjective,
     Optional<Item> craftItem,
     Item toolItem,
     float damageMultiplier,
@@ -39,7 +41,7 @@ public record TurtleToolSpec(
     public static final float DEFAULT_DAMAGE_MULTIPLIER = 3.0f;
 
     public static final MapCodec<TurtleToolSpec> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group(
-        Codec.STRING.fieldOf("adjective").forGetter(TurtleToolSpec::adjective),
+        ComponentSerialization.CODEC.fieldOf("adjective").forGetter(TurtleToolSpec::adjective),
         BuiltInRegistries.ITEM.byNameCodec().optionalFieldOf("craftingItem").forGetter(TurtleToolSpec::craftItem),
         BuiltInRegistries.ITEM.byNameCodec().fieldOf("item").forGetter(TurtleToolSpec::toolItem),
         Codec.FLOAT.optionalFieldOf("damageMultiplier", DEFAULT_DAMAGE_MULTIPLIER).forGetter(TurtleToolSpec::damageMultiplier),

projects/common/src/main/java/dan200/computercraft/data/LanguageProvider.java

@@ -9,7 +9,6 @@
 import dan200.computercraft.api.ComputerCraftTags;
 import dan200.computercraft.api.pocket.PocketUpgradeDataProvider;
 import dan200.computercraft.api.turtle.TurtleUpgradeDataProvider;
-import dan200.computercraft.api.upgrades.UpgradeBase;
 import dan200.computercraft.core.metrics.Metric;
 import dan200.computercraft.core.metrics.Metrics;
 import dan200.computercraft.shared.ModRegistry;
@@ -22,6 +21,8 @@
 import net.minecraft.data.CachedOutput;
 import net.minecraft.data.DataProvider;
 import net.minecraft.data.PackOutput;
+import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.contents.TranslatableContents;
 import net.minecraft.tags.TagKey;
 import net.minecraft.world.item.Item;
 
@@ -287,15 +288,21 @@ private Stream<String> getExpectedKeys() {
             BuiltInRegistries.ITEM.holders()
                 .filter(x -> x.key().location().getNamespace().equals(ComputerCraftAPI.MOD_ID))
                 .map(x -> x.value().getDescriptionId()),
-            turtleUpgrades.getGeneratedUpgrades().values().stream().map(UpgradeBase::getUnlocalisedAdjective),
-            pocketUpgrades.getGeneratedUpgrades().values().stream().map(UpgradeBase::getUnlocalisedAdjective),
+            turtleUpgrades.getGeneratedUpgrades().values().stream().flatMap(x -> getTranslationKeys(x.getAdjective())),
+            pocketUpgrades.getGeneratedUpgrades().values().stream().flatMap(x -> getTranslationKeys(x.getAdjective())),
             Metric.metrics().values().stream().map(x -> AggregatedMetric.TRANSLATION_PREFIX + x.name() + ".name"),
             ConfigSpec.serverSpec.entries().map(ConfigFile.Entry::translationKey),
             ConfigSpec.clientSpec.entries().map(ConfigFile.Entry::translationKey),
             ComputerSelector.options().values().stream().map(ComputerSelector.Option::translationKey)
         ).flatMap(x -> x);
     }
 
+    private static Stream<String> getTranslationKeys(Component component) {
+        if (component.getContents() instanceof TranslatableContents contents) return Stream.of(contents.getKey());
+
+        return component.getSiblings().stream().flatMap(LanguageProvider::getTranslationKeys);
+    }
+
     private void add(String id, String text) {
         Objects.requireNonNull(id, "id cannot be null");
         Objects.requireNonNull(text, "text cannot be null");

projects/common/src/main/java/dan200/computercraft/shared/pocket/items/PocketComputerItem.java

@@ -127,9 +127,7 @@ public Component getName(ItemStack stack) {
         var baseString = getDescriptionId(stack);
         var upgrade = getUpgrade(stack);
         if (upgrade != null) {
-            return Component.translatable(baseString + ".upgraded",
-                Component.translatable(upgrade.getUnlocalisedAdjective())
-            );
+            return Component.translatable(baseString + ".upgraded", upgrade.getAdjective());
         } else {
             return super.getName(stack);
         }

projects/common/src/main/java/dan200/computercraft/shared/turtle/items/TurtleItem.java

@@ -34,18 +34,11 @@ public Component getName(ItemStack stack) {
         var left = getUpgrade(stack, TurtleSide.LEFT);
         var right = getUpgrade(stack, TurtleSide.RIGHT);
         if (left != null && right != null) {
-            return Component.translatable(baseString + ".upgraded_twice",
-                Component.translatable(right.getUnlocalisedAdjective()),
-                Component.translatable(left.getUnlocalisedAdjective())
-            );
+            return Component.translatable(baseString + ".upgraded_twice", right.getAdjective(), left.getAdjective());
         } else if (left != null) {
-            return Component.translatable(baseString + ".upgraded",
-                Component.translatable(left.getUnlocalisedAdjective())
-            );
+            return Component.translatable(baseString + ".upgraded", left.getAdjective());
         } else if (right != null) {
-            return Component.translatable(baseString + ".upgraded",
-                Component.translatable(right.getUnlocalisedAdjective())
-            );
+            return Component.translatable(baseString + ".upgraded", right.getAdjective());
         } else {
             return Component.translatable(baseString);
         }

projects/common/src/testMod/resources/data/cctest/computercraft/turtle_upgrade/netherite_pickaxe.json

@@ -1,6 +1,6 @@
 {
     "type": "computercraft:tool",
-    "adjective": "upgrade.minecraft.diamond_pickaxe.adjective",
+    "adjective": "Netherite",
     "item": "minecraft:netherite_pickaxe",
     "allowEnchantments": true,
     "consumeDurability": "when_enchanted"

projects/common/src/testMod/resources/data/cctest/computercraft/turtle_upgrade/wooden_pickaxe.json

@@ -1,6 +1,6 @@
 {
     "type": "computercraft:tool",
-    "adjective": "upgrade.minecraft.diamond_pickaxe.adjective",
+    "adjective": "Wooden",
     "item": "minecraft:wooden_pickaxe",
     "consumeDurability": "always"
 }