Update TODOs and retarget certain ones for completion by the 1.21 release

Also addresses certain trivial TODOs

Author: pupnewfster

src/api/java/mekanism/api/SerializerHelper.java

@@ -17,7 +17,7 @@
 import net.minecraft.Util;
 import org.jetbrains.annotations.NotNull;
 
-//TODO - 1.20.5: Update the wiki docs to fix the syntax
+//TODO - 1.21: Update the wiki docs to fix the syntax
 @NothingNullByDefault
 public class SerializerHelper {
 

src/api/java/mekanism/api/chemical/BasicChemicalTank.java

@@ -53,17 +53,34 @@ public void setStack(STACK stack) {
     }
 
     /**
-     * Helper method to allow easily setting a rate at which this {@link BasicChemicalTank} can insert/extract chemicals.
+     * Helper method to allow easily setting a rate at which chemicals can be inserted into this {@link BasicChemicalTank}.
      *
      * @param automationType The automation type to limit the rate by or null if we don't have access to an automation type.
      *
      * @return The rate this tank can insert/extract at.
      *
      * @implNote By default, this returns {@link Long#MAX_VALUE} to not actually limit the tank's rate. By default, this is also ignored for direct setting of the
      * stack/stack size
+     *
+     * @since 10.6.0, previously was combined with {@link #getExtractRate(AutomationType)} as a method named getRate
+     */
+    protected long getInsertRate(@Nullable AutomationType automationType) {
+        return Long.MAX_VALUE;
+    }
+
+    /**
+     * Helper method to allow easily setting a rate at which chemicals can be extracted from this {@link BasicChemicalTank}.
+     *
+     * @param automationType The automation type to limit the rate by or null if we don't have access to an automation type.
+     *
+     * @return The rate this tank can insert/extract at.
+     *
+     * @implNote By default, this returns {@link Long#MAX_VALUE} to not actually limit the tank's rate. By default, this is also ignored for direct setting of the
+     * stack/stack size
+     *
+     * @since 10.6.0, previously was combined with {@link #getInsertRate(AutomationType)} as a method named getRate
      */
-    protected long getRate(@Nullable AutomationType automationType) {
-        //TODO: Decide if we want to split this into a rate for inserting and a rate for extracting.
+    protected long getExtractRate(@Nullable AutomationType automationType) {
         return Long.MAX_VALUE;
     }
 
@@ -95,7 +112,7 @@ public STACK insert(@NotNull STACK stack, Action action, AutomationType automati
             //"Fail quick" if the given stack is empty, or we can never insert the chemical or currently are unable to insert it
             return stack;
         }
-        long needed = Math.min(getRate(automationType), getNeeded());
+        long needed = Math.min(getInsertRate(automationType), getNeeded());
         if (needed <= 0) {
             //Fail if we are a full tank or our rate is zero
             return stack;
@@ -130,7 +147,7 @@ public STACK extract(long amount, Action action, AutomationType automationType)
         }
         //Note: While we technically could just return the stack itself if we are removing all that we have, it would require a lot more checks
         // We also are limiting it by the rate this tank has
-        long size = Math.min(Math.min(getRate(automationType), getStored()), amount);
+        long size = Math.min(Math.min(getExtractRate(automationType), getStored()), amount);
         if (size == 0) {
             return getEmptyStack();
         }
@@ -190,9 +207,11 @@ public long growStack(long amount, Action action) {
             return 0;
         } else if (amount > 0) {
             //Cap adding amount at how much we need, so that we don't risk long overflow
-            amount = Math.min(Math.min(amount, getNeeded()), getRate(null));
+            //If we are increasing the stack's size, use the insert rate
+            amount = Math.min(Math.min(amount, getNeeded()), getInsertRate(null));
         } else if (amount < 0) {
-            amount = Math.max(amount, -getRate(null));
+            //If we are decreasing the stack's size, use the extract rate
+            amount = Math.max(amount, -getExtractRate(null));
         }
         long newSize = setStackSize(current + amount, action);
         return newSize - current;

src/api/java/mekanism/api/chemical/merged/BoxedChemical.java

@@ -65,7 +65,7 @@ public class BoxedChemical implements IHasTextComponent {
      */
     public static BoxedChemical box(Chemical<?> chemical) {
         if (chemical.isEmptyType()) {
-            //TODO: Do we care that this can lose the type of chemical as it uses a single instance that always has a type of gas?
+            //TODO - 1.21: Do we care that this can lose the type of chemical as it uses a single instance that always has a type of gas?
             return EMPTY;
         }
         return new BoxedChemical(ChemicalType.getTypeFor(chemical), chemical);

src/api/java/mekanism/api/chemical/merged/BoxedChemicalStack.java

@@ -66,7 +66,7 @@ public class BoxedChemicalStack implements IHasTextComponent {
      */
     public static BoxedChemicalStack box(ChemicalStack<?> chemicalStack) {
         if (chemicalStack.isEmpty()) {
-            //TODO: Do we care that this can lose the type of chemical as it uses a single instance that always has a type of gas?
+            //TODO - 1.21: Do we care that this can lose the type of chemical as it uses a single instance that always has a type of gas?
             return EMPTY;
         }
         return new BoxedChemicalStack(ChemicalType.getTypeFor(chemicalStack), chemicalStack);

src/api/java/mekanism/api/gear/ICustomModule.java

@@ -195,6 +195,14 @@ default <MODE extends IRadialMode> boolean setMode(IModule<MODULE> module, Playe
 
     /**
      * Called when this module is added to an item.
+     * <p>
+     * Due to the way {@link net.minecraft.core.component.DataComponentType data components} work, the instance of the {@link ICustomModule} that this method gets called
+     * on is as follows:
+     * <ul>
+     *     <li>The passed in {@link IModuleContainer module container} instance is the new one that contains the added module in its known modules</li>
+     *     <li>The stack has been updated to know about the updated state (including any changes to enchantments if this module is also a {@link EnchantmentAwareModule})</li>
+     *     <li>The {@link ICustomModule} instance is one created after installing the modules</li>
+     * </ul>
      *
      * @param module          Module instance.
      * @param moduleContainer The container this module is part of.
@@ -209,6 +217,24 @@ default void onAdded(IModule<MODULE> module, IModuleContainer moduleContainer, I
 
     /**
      * Called when this module is removed from an item.
+     * <p>
+     * Due to the way {@link net.minecraft.core.component.DataComponentType data components} work, the instance of the {@link ICustomModule} that this method gets called
+     * on is as follows:
+     *
+     * <ul>
+     *     <li>
+     *         The passed in {@link IModuleContainer module container} instance is the new one that contains the reduced number of modules (or none if last) in its known
+     *         modules
+     *     </li>
+     *     <li>The stack has been updated to know about the updated state (including any changes to enchantments if this module is also a {@link EnchantmentAwareModule})</li>
+     *     <li>
+     *         If this was not the {@code wasLast} module removed, this behaves similarly to {@link #onAdded(IModule, IModuleContainer, ItemStack, boolean)} in that the
+     *         {@link ICustomModule} instance is one created after uninstalling the the modules. <strong>However</strong>, if all the modules of this type have been
+     *         removed and {@code wasLast == true}, then this method is instead called on the previously installed {@link ICustomModule} instance, and it should be assumed
+     *         that the number of installed modules is zero, rather than querying it via {@link IModule#getInstalledCount()}. Do note, even in this case, the stack and
+     *         {@link IModuleContainer module container} still point to the updated state, as specified above.
+     *     </li>
+     * </ul>
      *
      * @param module          Module instance.
      * @param moduleContainer The container this module is part of.

src/api/java/mekanism/api/recipes/MekanismRecipe.java

@@ -14,7 +14,8 @@ public abstract class MekanismRecipe implements Recipe<IgnoredIInventory> {//TOD
 
     @Override
     public boolean matches(@NotNull IgnoredIInventory inv, @NotNull Level world) {
-        //TODO: Decide if we ever want to make use of this method
+        //TODO - 1.21: Decide if we ever want to make use of this method, as with the changes in 1.21 to allow for extending RecipeInput
+        // instead of Container, we potentially could implement this even for things that don't use items
         //Default to not being able to match incomplete recipes though
         return !isIncomplete();
     }

src/datagen/main/java/mekanism/client/integration/emi/BaseEmiAliasProvider.java

@@ -117,7 +117,7 @@ protected void addAliases(List<EmiIngredient> stacks, IHasTranslationKey... alia
               .map(IHasTranslationKey::getTranslationKey)
               .sorted()
               .toList();
-        //TODO - 1.20.5: Is there some global sort, or stack based sort we can apply as well?
+        //TODO: Is there some global sort, or stack based sort we can apply as well?
         if (!data.add(new AliasInfo(stacks, sortedAliases))) {
             //TODO: Can we improve the validation we have relating to duplicate values/make things more compact?
             // This if statement exists mainly as a simple check against copy-paste errors

src/datagen/main/java/mekanism/client/integration/emi/MekanismEmiAliasProvider.java

@@ -220,7 +220,7 @@ private void addStorageAliases() {
               MekanismAliases.SLURRY_STORAGE
         );
 
-        //TODO - 1.20.5: Fix energy stuff not displaying properly when searching for "energy storage"? Probably has to do with components
+        //TODO - 1.21: Fix energy stuff not displaying properly when searching for "energy storage"? Probably has to do with components
         addAliases(List.of(
               EmiStack.of(MekanismBlocks.BASIC_ENERGY_CUBE),
               EmiStack.of(MekanismBlocks.ADVANCED_ENERGY_CUBE),
@@ -233,7 +233,7 @@ private void addStorageAliases() {
         addAliases(MekanismItems.ENERGY_TABLET, MekanismAliases.ENERGY_STORAGE, MekanismAliases.ENERGY_STORAGE_BATTERY);
 
         addAliases(List.of(
-              //TODO - 1.20.5: Why does the creative bin not show up?
+              //TODO - 1.21: Why does the creative bin not show up?
               EmiStack.of(MekanismBlocks.CREATIVE_BIN),
               EmiStack.of(MekanismBlocks.CREATIVE_FLUID_TANK),
               EmiStack.of(MekanismBlocks.CREATIVE_CHEMICAL_TANK),

src/datagen/main/java/mekanism/client/lang/FormatSplitter.java

@@ -209,6 +209,8 @@ public boolean isChoice() {
          *
          * @return A {@link MessageFormatComponent} representing the given contents, or {@code null} if the contents do not represent a valid
          * {@link MessageFormatComponent}
+         *
+         * @see net.neoforged.fml.i18n.FMLTranslations
          */
         @Nullable
         private static MessageFormatComponent fromContents(String contents) {
@@ -287,9 +289,9 @@ private static MessageFormatComponent fromContents(String contents) {
                         return null;
                     }
                 }
-                case "featurebound", "lower", "upper", "vr" -> {
+                case "featurebound", "lower", "upper", "vr", "i18ntranslate" -> {
                     if (formatStyle != null) {
-                        //featurebound, lower, upper, and vr do not support any format style
+                        //None of these support any format style
                         return null;
                     }
                 }

src/datagen/main/java/mekanism/common/recipe/RecipeProviderUtil.java

@@ -50,7 +50,7 @@ public static void addSmeltingBlastingRecipes(RecipeOutput consumer, Ingredient
 
     public static void addCrusherBioFuelRecipes(RecipeOutput consumer, String basePath, Predicate<String> shouldHandle, @Nullable ICondition condition) {
         //Generate baseline recipes from Composter recipe set
-        //TODO - 1.20.4: Move these to being "generated" recipes at runtime (maybe behind a config option) that uses the compostable datamap?
+        //TODO - 1.21: Move these to being "generated" recipes at runtime (maybe behind a config option) that uses the compostable datamap?
         for (Object2FloatMap.Entry<ItemLike> chance : ComposterBlock.COMPOSTABLES.object2FloatEntrySet()) {
             Item input = chance.getKey().asItem();
             ResourceLocation name = RegistryUtils.getName(input);