Adjust some TODOs for when they are targeted

mekanism · Dec 20, 2021 · 6347a88 · 6347a88
1 parent 311dc12
commit 6347a88
Show file tree

Hide file tree

Showing 101 changed files with 130 additions and 130 deletions.
diff --git a/annotation-processor/src/main/java/mekanism/CraftTweakerParamNameMapper.java b/annotation-processor/src/main/java/mekanism/CraftTweakerParamNameMapper.java
@@ -77,7 +77,7 @@ public Set<String> getSupportedAnnotationTypes() {
 
     @Override
     public SourceVersion getSupportedSourceVersion() {
-        //TODO - 1.17: Java 16
+        //TODO - 1.18: Java 17
         return SourceVersion.RELEASE_8;
     }
 }
diff --git a/src/api/java/mekanism/api/Coord4D.java b/src/api/java/mekanism/api/Coord4D.java
@@ -58,7 +58,7 @@ public Coord4D(double x, double y, double z, RegistryKey<World> dimension) {
      * @param pos   Position (x, y, z)
      * @param world World
      */
-    public Coord4D(BlockPos pos, World world) {//TODO - 1.17: Switch this to taking Vector3i as position
+    public Coord4D(BlockPos pos, World world) {//TODO - 1.18: Switch this to taking Vector3i as position
         this(pos, world.dimension());
     }
 
@@ -68,12 +68,12 @@ public Coord4D(BlockPos pos, World world) {//TODO - 1.17: Switch this to taking
      * @param pos       Position (x, y, z)
      * @param dimension Dimension ID
      */
-    public Coord4D(BlockPos pos, RegistryKey<World> dimension) {//TODO - 1.17: Switch this to taking Vector3i as position
+    public Coord4D(BlockPos pos, RegistryKey<World> dimension) {//TODO - 1.18: Switch this to taking Vector3i as position
         this(pos.getX(), pos.getY(), pos.getZ(), dimension);
     }
 
     @Deprecated
-    public Coord4D(BlockRayTraceResult mop, World world) {//TODO - 1.17: Remove this
+    public Coord4D(BlockRayTraceResult mop, World world) {//TODO - 1.18: Remove this
         this(mop.getBlockPos(), world);
     }
 
@@ -84,7 +84,7 @@ public Coord4D(BlockRayTraceResult mop, World world) {//TODO - 1.17: Remove this
      *
      * @return the Coord4D object from the TileEntity
      */
-    public static Coord4D get(TileEntity tile) {//TODO - 1.17: Move this to a constructor or move the other helper constructors to a get method
+    public static Coord4D get(TileEntity tile) {//TODO - 1.18: Move this to a constructor or move the other helper constructors to a get method
         return new Coord4D(tile.getBlockPos(), tile.getLevel());
     }
 

diff --git a/src/api/java/mekanism/api/IAlloyInteraction.java b/src/api/java/mekanism/api/IAlloyInteraction.java
@@ -21,6 +21,6 @@ public interface IAlloyInteraction {
      * @param stack  - the stack of alloy being right-clicked
      * @param tier   - the tier of the alloy
      */
-    //TODO - 1.17: Remove the hand parameter as it is not needed
+    //TODO - 1.18: Remove the hand parameter as it is not needed
     void onAlloyInteraction(PlayerEntity player, Hand hand, ItemStack stack, @Nonnull AlloyTier tier);
 }
diff --git a/src/api/java/mekanism/api/IConfigurable.java b/src/api/java/mekanism/api/IConfigurable.java
@@ -9,7 +9,7 @@
  *
  * @author aidancbrady
  */
-public interface IConfigurable {//TODO - 1.17: Make the capability instance handle what side we interact with these from and remove the side from the methods
+public interface IConfigurable {//TODO - 1.18: Make the capability instance handle what side we interact with these from and remove the side from the methods
 
     /**
      * Called when a player shift-right clicks this block with a Configurator.

diff --git a/src/api/java/mekanism/api/MekanismAPI.java b/src/api/java/mekanism/api/MekanismAPI.java
@@ -47,7 +47,7 @@ private MekanismAPI() {
     private static ITooltipHelper TOOLTIP_HELPER;
 
     //Note: None of the empty variants support registry replacement
-    //TODO - 1.17: Rename registry names for the empty types to just being mekanism:empty instead of mekanism:empty_type,
+    //TODO - 1.18: Rename registry names for the empty types to just being mekanism:empty instead of mekanism:empty_type,
     // and also potentially define these with ObjectHolder for purposes of fully defining them outside of the API
     /**
      * Empty Gas instance.

diff --git a/src/api/java/mekanism/api/NBTConstants.java b/src/api/java/mekanism/api/NBTConstants.java
@@ -193,7 +193,7 @@ private NBTConstants() {
     public static final String STOCK_CONTROL = "stockControl";
     public static final String STORED = "stored";
     public static final String STRICT_INPUT = "strictInput";
-    @Deprecated//TODO - 1.17: Remove
+    @Deprecated//TODO - 1.18: Remove
     public static final String SUCKED_LAST_OPERATION = "suckedLastOperation";
     public static final String TAG_NAME = "tagName";
     public static final String TANK = "Tank";

diff --git a/src/api/java/mekanism/api/Range3D.java b/src/api/java/mekanism/api/Range3D.java
@@ -3,7 +3,7 @@
 import net.minecraft.util.RegistryKey;
 import net.minecraft.world.World;
 
-//TODO - 1.17: Move this out of the API
+//TODO - 1.18: Move this out of the API
 public class Range3D {
 
     public final RegistryKey<World> dimension;

diff --git a/src/api/java/mekanism/api/Upgrade.java b/src/api/java/mekanism/api/Upgrade.java
@@ -83,7 +83,7 @@ public static void saveMap(Map<Upgrade, Integer> upgrades, CompoundNBT nbtTags)
      *
      * @deprecated use {@link #getTag(int)} instead.
      */
-    @Deprecated//TODO - 1.17: Remove this
+    @Deprecated//TODO - 1.18: Remove this
     public static CompoundNBT getTagFor(Upgrade upgrade, int amount) {
         CompoundNBT compound = new CompoundNBT();
         compound.putInt(NBTConstants.TYPE, upgrade.ordinal());
@@ -143,7 +143,7 @@ public EnumColor getColor() {
      *
      * @return {@code true} if the upgrade has multiple levels.
      */
-    @Deprecated//TODO - 1.17: Remove this
+    @Deprecated//TODO - 1.18: Remove this
     public boolean canMultiply() {
         return getMax() > 1;
     }

diff --git a/src/api/java/mekanism/api/chemical/ChemicalStack.java b/src/api/java/mekanism/api/chemical/ChemicalStack.java
@@ -15,7 +15,7 @@
 import net.minecraft.util.text.ITextComponent;
 import net.minecraftforge.registries.IRegistryDelegate;
 
-//TODO - 1.17: Make the subclasses of this final
+//TODO - 1.18: Make the subclasses of this final
 @ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
 public abstract class ChemicalStack<CHEMICAL extends Chemical<CHEMICAL>> implements IHasTextComponent, IHasTranslationKey {

diff --git a/src/api/java/mekanism/api/chemical/ChemicalTankBuilder.java b/src/api/java/mekanism/api/chemical/ChemicalTankBuilder.java
@@ -175,7 +175,7 @@ public TANK output(long capacity, @Nullable IContentsListener listener) {
         return tankCreator.create(capacity, alwaysTrueBi, internalOnly, alwaysTrue, ChemicalAttributeValidator.ALWAYS_ALLOW, listener);
     }
 
-    @Deprecated//TODO - 1.17: Remove
+    @Deprecated//TODO - 1.18: Remove
     public TANK ejectOutput(long capacity, @Nullable IContentsListener listener) {
         if (capacity < 0) {
             throw new IllegalArgumentException("Capacity must be at least zero");

diff --git a/src/api/java/mekanism/api/datagen/recipe/builder/ChemicalInfuserRecipeBuilder.java b/src/api/java/mekanism/api/datagen/recipe/builder/ChemicalInfuserRecipeBuilder.java
@@ -8,7 +8,7 @@
 import mekanism.api.recipes.inputs.chemical.GasStackIngredient;
 import net.minecraft.util.ResourceLocation;
 
-//TODO - 1.17: Get rid of this class and move the helpers to ChemicalChemicalToChemicalRecipeBuilder
+//TODO - 1.18: Get rid of this class and move the helpers to ChemicalChemicalToChemicalRecipeBuilder
 @Deprecated
 @ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault

diff --git a/...i/java/mekanism/api/datagen/recipe/builder/ItemStackChemicalToItemStackRecipeBuilder.java b/...i/java/mekanism/api/datagen/recipe/builder/ItemStackChemicalToItemStackRecipeBuilder.java
@@ -35,7 +35,7 @@ public class ItemStackChemicalToItemStackRecipeBuilder<CHEMICAL extends Chemical
     private final ItemStackIngredient itemInput;
     private final INGREDIENT chemicalInput;
     private final ItemStack output;
-    //TODO - 1.17: Just inline this as JsonConstants.CHEMICAL_INPUT
+    //TODO - 1.18: Just inline this as JsonConstants.CHEMICAL_INPUT
     private final String chemicalInputKey;
 
     protected ItemStackChemicalToItemStackRecipeBuilder(ResourceLocation serializerName, ItemStackIngredient itemInput, INGREDIENT chemicalInput, ItemStack output,

diff --git a/src/api/java/mekanism/api/datagen/recipe/builder/ItemStackGasToItemStackRecipeBuilder.java b/src/api/java/mekanism/api/datagen/recipe/builder/ItemStackGasToItemStackRecipeBuilder.java
@@ -10,7 +10,7 @@
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.ResourceLocation;
 
-@Deprecated//TODO - 1.17: Remove
+@Deprecated//TODO - 1.18: Remove
 @ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
 public class ItemStackGasToItemStackRecipeBuilder extends ItemStackChemicalToItemStackRecipeBuilder<Gas, GasStack, GasStackIngredient> {

diff --git a/src/api/java/mekanism/api/datagen/recipe/builder/MetallurgicInfuserRecipeBuilder.java b/src/api/java/mekanism/api/datagen/recipe/builder/MetallurgicInfuserRecipeBuilder.java
@@ -10,7 +10,7 @@
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.ResourceLocation;
 
-@Deprecated//TODO - 1.17: Remove
+@Deprecated//TODO - 1.18: Remove
 @ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
 public class MetallurgicInfuserRecipeBuilder extends ItemStackChemicalToItemStackRecipeBuilder<InfuseType, InfusionStack, InfusionStackIngredient> {

diff --git a/src/api/java/mekanism/api/fluid/IExtendedFluidTank.java b/src/api/java/mekanism/api/fluid/IExtendedFluidTank.java
@@ -37,7 +37,7 @@ public interface IExtendedFluidTank extends IFluidTank, INBTSerializable<Compoun
      * @implNote If the internal stack does get updated make sure to call {@link #onContentsChanged()}
      */
     default void setStackUnchecked(FluidStack stack) {
-        //TODO - 1.17: Remove default implementation. This is mainly here to not be a breaking change on the off-chance anyone actually
+        //TODO - 1.18: Remove default implementation. This is mainly here to not be a breaking change on the off-chance anyone actually
         // has a custom implementation of our extended fluid tank
         setStack(stack);
     }

diff --git a/src/api/java/mekanism/api/gear/ICustomModule.java b/src/api/java/mekanism/api/gear/ICustomModule.java
@@ -185,7 +185,7 @@ default ModuleDispenseResult onDispense(IModule<MODULE> module, IBlockSource sou
         return ModuleDispenseResult.DEFAULT;
     }
 
-    //TODO - 1.17: Switch this to a record
+    //TODO - 1.18: Switch this to a record
     class ModuleDamageAbsorbInfo {
 
         private final FloatSupplier absorptionRatio;

diff --git a/src/api/java/mekanism/api/gear/ModuleData.java b/src/api/java/mekanism/api/gear/ModuleData.java
@@ -73,10 +73,10 @@ public final ModuleData<MODULE> getModuleData() {
      * Gets the legacy name for this module. This is mainly used to be able to load legacy modules from before the module system was exposed to the API and modules had a
      * slightly different naming scheme.
      *
-     * @deprecated Will be removed in 1.17
+     * @deprecated Will be removed in 1.18
      */
     @Nullable
-    @Deprecated//TODO - 1.17: Remove
+    @Deprecated//TODO - 1.18: Remove
     public final String getLegacyName() {
         return legacyName;
     }
@@ -235,9 +235,9 @@ private ModuleDataBuilder(@Nonnull NonNullSupplier<MODULE> supplier, @Nonnull II
          *
          * @param legacyName Legacy name of the module.
          *
-         * @deprecated Will be removed in 1.17
+         * @deprecated Will be removed in 1.18
          */
-        @Deprecated//TODO - 1.17: Remove
+        @Deprecated//TODO - 1.18: Remove
         public ModuleDataBuilder<MODULE> legacyName(@Nonnull String legacyName) {
             this.legacyName = Objects.requireNonNull(legacyName, "Legacy name should not be null if specified.");
             return this;

diff --git a/src/api/java/mekanism/api/inventory/AutomationType.java b/src/api/java/mekanism/api/inventory/AutomationType.java
@@ -1,6 +1,6 @@
 package mekanism.api.inventory;
 
-//TODO - 1.17: Move this out of the inventory submodule in the API
+//TODO - 1.18: Move this out of the inventory submodule in the API
 public enum AutomationType {
     EXTERNAL,
     INTERNAL,

diff --git a/src/api/java/mekanism/api/lasers/ILaserReceptor.java b/src/api/java/mekanism/api/lasers/ILaserReceptor.java
@@ -15,7 +15,7 @@ public interface ILaserReceptor {
      * @param energy Energy received.
      * @param side   Side the receptor is hit from (will be removed in 1.17 as what capability instance is returned can be used to have different handling of this)
      */
-    void receiveLaserEnergy(@Nonnull FloatingLong energy, Direction side);//TODO - 1.17: Remove the side from this as the side is used when getting the capability.
+    void receiveLaserEnergy(@Nonnull FloatingLong energy, Direction side);//TODO - 1.18: Remove the side from this as the side is used when getting the capability.
 
     /**
      * Checks if a laser can break this receptor.

diff --git a/src/api/java/mekanism/api/providers/IBlockProvider.java b/src/api/java/mekanism/api/providers/IBlockProvider.java
@@ -12,13 +12,13 @@ public interface IBlockProvider extends IItemProvider {
     @Nonnull
     Block getBlock();
 
-    @Deprecated//TODO - 1.17: Remove this as we don't actually use this
+    @Deprecated//TODO - 1.18: Remove this as we don't actually use this
     default boolean blockMatches(ItemStack otherStack) {
         Item item = otherStack.getItem();
         return item instanceof BlockItem && blockMatches(((BlockItem) item).getBlock());
     }
 
-    @Deprecated//TODO - 1.17: Remove this as we don't actually use this
+    @Deprecated//TODO - 1.18: Remove this as we don't actually use this
     default boolean blockMatches(Block other) {
         return getBlock() == other;
     }

diff --git a/src/api/java/mekanism/api/providers/IFluidProvider.java b/src/api/java/mekanism/api/providers/IFluidProvider.java
@@ -15,7 +15,7 @@ public interface IFluidProvider extends IBaseProvider {
     Fluid getFluid();
 
     //Note: Uses FluidStack in case we want to check NBT or something
-    @Deprecated//TODO - 1.17: Remove this as we don't actually use this
+    @Deprecated//TODO - 1.18: Remove this as we don't actually use this
     default boolean fluidMatches(FluidStack other) {
         return getFluid() == other.getFluid();
     }

diff --git a/src/api/java/mekanism/api/providers/IItemProvider.java b/src/api/java/mekanism/api/providers/IItemProvider.java
@@ -11,7 +11,7 @@ public interface IItemProvider extends IBaseProvider, net.minecraft.util.IItemPr
      * Gets the item this provider represents.
      */
     @Nonnull
-    Item getItem();//TODO - 1.17: Replace this with just using vanilla's asItem?
+    Item getItem();//TODO - 1.18: Replace this with just using vanilla's asItem?
 
     @Nonnull
     @Override
@@ -37,12 +37,12 @@ default ItemStack getItemStack(int size) {
         return new ItemStack(getItem(), size);
     }
 
-    @Deprecated//TODO - 1.17: Remove this as we don't actually use this
+    @Deprecated//TODO - 1.18: Remove this as we don't actually use this
     default boolean itemMatches(ItemStack otherStack) {
         return itemMatches(otherStack.getItem());
     }
 
-    @Deprecated//TODO - 1.17: Remove this as we don't actually use this
+    @Deprecated//TODO - 1.18: Remove this as we don't actually use this
     default boolean itemMatches(Item other) {
         return getItem() == other;
     }

diff --git a/src/api/java/mekanism/api/recipes/ChemicalDissolutionRecipe.java b/src/api/java/mekanism/api/recipes/ChemicalDissolutionRecipe.java
@@ -93,7 +93,7 @@ public boolean test(ItemStack itemStack, GasStack gasStack) {
      * @return Representation of the output, <strong>MUST NOT</strong> be modified.
      */
     public BoxedChemicalStack getOutputDefinition() {
-        //TODO - 1.17: Re-evaluate this method not being a list
+        //TODO - 1.18: Re-evaluate this method not being a list
         return output;
     }
 

diff --git a/src/api/java/mekanism/api/recipes/ElectrolysisRecipe.java b/src/api/java/mekanism/api/recipes/ElectrolysisRecipe.java
@@ -73,7 +73,7 @@ public FluidStackIngredient getInput() {
      * @return Representation of the left output, <strong>MUST NOT</strong> be modified.
      */
     public GasStack getLeftGasOutputRepresentation() {
-        //TODO - 1.17: Re-evaluate this method and the other output representation method not being lists.
+        //TODO - 1.18: Re-evaluate this method and the other output representation method not being lists.
         // Strictly speaking it should be a list of pairs of gas stacks
         return leftGasOutput;
     }

diff --git a/src/api/java/mekanism/api/recipes/FluidToFluidRecipe.java b/src/api/java/mekanism/api/recipes/FluidToFluidRecipe.java
@@ -59,7 +59,7 @@ public FluidStackIngredient getInput() {
     /**
      * @deprecated Use {@link #getOutputDefinition()}.
      */
-    @Deprecated//TODO - 1.17: Remove this
+    @Deprecated//TODO - 1.18: Remove this
     public FluidStack getOutputRepresentation() {
         return output;
     }

diff --git a/src/api/java/mekanism/api/recipes/ItemStackToEnergyRecipe.java b/src/api/java/mekanism/api/recipes/ItemStackToEnergyRecipe.java
@@ -76,7 +76,7 @@ public FloatingLong getOutput(ItemStack input) {
      * @return Representation of the output, <strong>MUST NOT</strong> be modified.
      */
     public FloatingLong getOutputDefinition() {
-        //TODO - 1.17: Re-evaluate this method not being a list
+        //TODO - 1.18: Re-evaluate this method not being a list
         return output;
     }
 

diff --git a/src/api/java/mekanism/api/recipes/MetallurgicInfuserRecipe.java b/src/api/java/mekanism/api/recipes/MetallurgicInfuserRecipe.java
@@ -40,15 +40,15 @@ public MetallurgicInfuserRecipe(ResourceLocation id, ItemStackIngredient itemInp
     /**
      * @deprecated Switch to using {@link ItemStackChemicalToItemStackRecipe#test(ItemStack, ChemicalStack)}
      */
-    @Deprecated//TODO - 1.17: Remove this method
+    @Deprecated//TODO - 1.18: Remove this method
     public boolean test(InfusionStack infusionContainer, ItemStack itemStack) {
         return test(itemStack, infusionContainer);
     }
 
     /**
      * @deprecated Switch to using {@link ItemStackChemicalToItemStackRecipe#getOutput(ItemStack, ChemicalStack)}
      */
-    @Deprecated//TODO - 1.17: Remove this method
+    @Deprecated//TODO - 1.18: Remove this method
     @Contract(value = "_, _ -> new", pure = true)
     public ItemStack getOutput(InfusionStack inputInfuse, ItemStack inputItem) {
         return getOutput(inputItem, inputInfuse);
@@ -57,7 +57,7 @@ public ItemStack getOutput(InfusionStack inputInfuse, ItemStack inputItem) {
     /**
      * @deprecated Switch to using {@link ItemStackChemicalToItemStackRecipe#getChemicalInput()}
      */
-    @Deprecated//TODO - 1.17: Remove this method
+    @Deprecated//TODO - 1.18: Remove this method
     public InfusionStackIngredient getInfusionInput() {
         return getChemicalInput();
     }

diff --git a/src/api/java/mekanism/api/recipes/PressurizedReactionRecipe.java b/src/api/java/mekanism/api/recipes/PressurizedReactionRecipe.java
@@ -129,7 +129,7 @@ public boolean test(ItemStack solid, FluidStack liquid, GasStack gas) {
      * @return Representation of the output, <strong>MUST NOT</strong> be modified.
      */
     public Pair<List<@NonNull ItemStack>, @NonNull GasStack> getOutputDefinition() {
-        //TODO - 1.17: Re-evaluate the fact that this isn't a list of pairs
+        //TODO - 1.18: Re-evaluate the fact that this isn't a list of pairs
         if (outputItem.isEmpty()) {
             return Pair.of(Collections.emptyList(), this.outputGas);
         }

diff --git a/src/api/java/mekanism/api/recipes/RotaryRecipe.java b/src/api/java/mekanism/api/recipes/RotaryRecipe.java
@@ -31,7 +31,7 @@
 @MethodsReturnNonnullByDefault
 public abstract class RotaryRecipe extends MekanismRecipe {
 
-    //TODO - 1.17: Evaluate making ingredients not able to even be built from empty stacks and just switch these to being null here
+    //TODO - 1.18: Evaluate making ingredients not able to even be built from empty stacks and just switch these to being null here
     private static final GasStackIngredient EMPTY_GAS_INPUT = GasStackIngredient.from(GasStack.EMPTY);
     private static final FluidStackIngredient EMPTY_FLUID_INPUT = FluidStackIngredient.from(FluidStack.EMPTY);
     private final GasStackIngredient gasInput;
@@ -173,7 +173,7 @@ public GasStackIngredient getGasInput() {
     /**
      * @deprecated Use {@link #getGasOutputDefinition()}.
      */
-    @Deprecated//TODO - 1.17: Remove this
+    @Deprecated//TODO - 1.18: Remove this
     public GasStack getGasOutputRepresentation() {
         return gasOutput;
     }
@@ -190,7 +190,7 @@ public List<GasStack> getGasOutputDefinition() {
     /**
      * @deprecated Use {@link #getFluidOutputDefinition()}.
      */
-    @Deprecated//TODO - 1.17: Remove this
+    @Deprecated//TODO - 1.18: Remove this
     public FluidStack getFluidOutputRepresentation() {
         return fluidOutput;
     }

diff --git a/src/api/java/mekanism/api/recipes/SawmillRecipe.java b/src/api/java/mekanism/api/recipes/SawmillRecipe.java
@@ -59,7 +59,7 @@ public SawmillRecipe(ResourceLocation id, ItemStackIngredient input, ItemStack m
             if (secondaryChance == 0) {
                 throw new IllegalArgumentException("Secondary output must have a chance greater than zero.");
             } else if (secondaryChance == 1) {
-                //TODO - 1.17: Replace this handling that moves the secondary output to the main output with an exception
+                //TODO - 1.18: Replace this handling that moves the secondary output to the main output with an exception
                 // This will also need to be double checked in the recipe serializer and in the CrT integration
                 this.mainOutput = secondaryOutput.copy();
                 this.secondaryOutput = ItemStack.EMPTY;