Research station logic improvement (GregTechCEu#2097)

Author: serenibyss

src/main/java/gregtech/api/capability/impl/ComputationRecipeLogic.java

@@ -5,6 +5,7 @@
 import gregtech.api.metatileentity.multiblock.RecipeMapMultiblockController;
 import gregtech.api.recipes.Recipe;
 import gregtech.api.recipes.recipeproperties.ComputationProperty;
+import gregtech.api.recipes.recipeproperties.TotalComputationProperty;
 import net.minecraft.nbt.NBTTagCompound;
 import org.jetbrains.annotations.NotNull;
 
@@ -16,8 +17,16 @@
 public class ComputationRecipeLogic extends MultiblockRecipeLogic {
 
     private final ComputationType type;
+    /*
+     * Whether recipe duration should be treated as a total CWU value (so, incremented by the CWU/t used each tick),
+     * or normally (increase by 1 for each successful draw of CWU/t). If this value is true, the logic will attempt
+     * to draw as much CWU/t as possible to try and accelerate the computation process, and CWU/t is treated as a
+     * minimum value instead of a static cost.
+     */
+    private boolean isDurationTotalCWU;
     private int recipeCWUt;
     private boolean hasNotEnoughComputation;
+    private int currentDrawnCWUt;
 
     public ComputationRecipeLogic(RecipeMapMultiblockController metaTileEntity, ComputationType type) {
         super(metaTileEntity);
@@ -50,6 +59,7 @@ public boolean checkRecipe(@NotNull Recipe recipe) {
     protected void setupRecipe(Recipe recipe) {
         super.setupRecipe(recipe);
         this.recipeCWUt = recipe.getProperty(ComputationProperty.getInstance(), 0);
+        this.isDurationTotalCWU = recipe.hasProperty(TotalComputationProperty.getInstance());
     }
 
     @Override
@@ -63,15 +73,24 @@ protected void updateRecipeProgress() {
             drawEnergy(recipeEUt, false);
 
             IOpticalComputationProvider provider = getComputationProvider();
-            int availableCWUt = provider.requestCWUt(recipeCWUt, true);
+            int availableCWUt = provider.requestCWUt(Integer.MAX_VALUE, true);
             if (availableCWUt >= recipeCWUt) {
                 // carry on as normal
                 this.hasNotEnoughComputation = false;
-                provider.requestCWUt(recipeCWUt, false);
-                if (++progressTime > maxProgressTime) {
+                if (isDurationTotalCWU) {
+                    // draw as much CWU as possible, and increase progress by this amount
+                    currentDrawnCWUt = provider.requestCWUt(availableCWUt, false);
+                    progressTime += currentDrawnCWUt;
+                } else {
+                    // draw only the recipe CWU/t, and increase progress by 1
+                    provider.requestCWUt(recipeCWUt, false);
+                    progressTime++;
+                }
+                if (progressTime > maxProgressTime) {
                     completeRecipe();
                 }
             } else {
+                currentDrawnCWUt = 0;
                 this.hasNotEnoughComputation = true;
                 // only decrement progress for low CWU/t if we need a steady supply
                 if (type == ComputationType.STEADY) {
@@ -91,13 +110,19 @@ protected void updateRecipeProgress() {
     protected void completeRecipe() {
         super.completeRecipe();
         this.recipeCWUt = 0;
+        this.isDurationTotalCWU = false;
         this.hasNotEnoughComputation = false;
+        this.currentDrawnCWUt = 0;
     }
 
     public int getRecipeCWUt() {
         return recipeCWUt;
     }
 
+    public int getCurrentDrawnCWUt() {
+        return isDurationTotalCWU ? currentDrawnCWUt : recipeCWUt;
+    }
+
     public boolean isHasNotEnoughComputation() {
         return hasNotEnoughComputation;
     }
@@ -108,6 +133,7 @@ public NBTTagCompound serializeNBT() {
         NBTTagCompound compound = super.serializeNBT();
         if (this.progressTime > 0) {
             compound.setInteger("RecipeCWUt", recipeCWUt);
+            compound.setBoolean("IsDurationTotalCWU", isDurationTotalCWU);
         }
         return compound;
     }
@@ -117,9 +143,18 @@ public void deserializeNBT(@NotNull NBTTagCompound compound) {
         super.deserializeNBT(compound);
         if (this.progressTime > 0) {
             recipeCWUt = compound.getInteger("RecipeCWUt");
+            isDurationTotalCWU = compound.getBoolean("IsDurationTotalCWU");
         }
     }
 
+
+    /**
+     * @return Whether TOP / WAILA should show the recipe progress as duration or as total computation.
+     */
+    public boolean shouldShowDuration() {
+        return !isDurationTotalCWU;
+    }
+
     public enum ComputationType {
         /**
          * CWU/t works like EU/t. If there is not enough, recipe reverts progress/halts

src/main/java/gregtech/api/recipes/RecipeMap.java

@@ -926,9 +926,12 @@ private VirtualizedRecipeMap getGroovyScriptRecipeMap() {
 
     /**
      * This height is used to determine Y position to start drawing info on JEI.
+     * @deprecated remove overrides, this method is no longer used in any way.
      */
+    @Deprecated
+    @ApiStatus.ScheduledForRemoval(inVersion = "2.9")
     public int getPropertyListHeight(Recipe recipe) {
-        return (recipe.getUnhiddenPropertyCount() + 3) * 10 - 3; // GTRecipeWrapper#LINE_HEIGHT
+        return 0;
     }
 
     /**

src/main/java/gregtech/api/recipes/builders/AssemblyLineRecipeBuilder.java

@@ -1,9 +1,6 @@
 package gregtech.api.recipes.builders;
 
-import gregtech.api.GTValues;
-import gregtech.api.items.metaitem.MetaItem;
 import gregtech.api.items.metaitem.stats.IDataItem;
-import gregtech.api.items.metaitem.stats.IItemBehaviour;
 import gregtech.api.recipes.Recipe;
 import gregtech.api.recipes.RecipeBuilder;
 import gregtech.api.recipes.RecipeMap;
@@ -12,7 +9,6 @@
 import gregtech.api.util.AssemblyLineManager;
 import gregtech.api.util.EnumValidationResult;
 import gregtech.api.util.GTLog;
-import gregtech.api.util.GTStringUtils;
 import gregtech.common.ConfigHolder;
 import net.minecraft.item.ItemStack;
 
@@ -24,11 +20,6 @@
 
 public class AssemblyLineRecipeBuilder extends RecipeBuilder<AssemblyLineRecipeBuilder> {
 
-    public static final int DEFAULT_SCANNER_DURATION = 1200; // 60 secs
-    public static final int DEFAULT_SCANNER_EUT = GTValues.VA[GTValues.HV];
-    public static final int DEFAULT_STATION_DURATION = 4000; // 200 secs
-    public static final int DEFAULT_STATION_EUT = GTValues.VA[GTValues.LuV];
-
     private final Collection<ResearchRecipeEntry> recipeEntries = new ArrayList<>();
 
     private boolean generatingRecipes = true;
@@ -55,7 +46,7 @@ public AssemblyLineRecipeBuilder copy() {
     public boolean applyProperty(@Nonnull String key, @Nullable Object value) {
         if (key.equals(ResearchProperty.KEY)) {
             if (value instanceof ItemStack itemStack) {
-                research(itemStack);
+                scannerResearch(itemStack);
                 return true;
             }
         }
@@ -115,22 +106,36 @@ public AssemblyLineRecipeBuilder researchWithoutRecipe(@Nonnull String researchI
         return this;
     }
 
-    public AssemblyLineRecipeBuilder research(UnaryOperator<ResearchBuilder> research) {
-        ResearchRecipeEntry entry = research.apply(new ResearchBuilder()).build();
+    /**
+     * Generates a research recipe for the Scanner.
+     */
+    public AssemblyLineRecipeBuilder scannerResearch(UnaryOperator<ResearchRecipeBuilder.ScannerRecipeBuilder> research) {
+        ResearchRecipeEntry entry = research.apply(new ResearchRecipeBuilder.ScannerRecipeBuilder()).build();
         if (applyResearchProperty(new ResearchPropertyData.ResearchEntry(entry.researchId, entry.dataStack))) {
             this.recipeEntries.add(entry);
         }
         return this;
     }
 
     /**
-     * Generates a research recipe.
+     * Generates a research recipe for the Scanner. All values are defaults other than the research stack.
      *
      * @param researchStack the stack to use for research
      * @return this
      */
-    public AssemblyLineRecipeBuilder research(@Nonnull ItemStack researchStack) {
-        return research(b -> new ResearchBuilder().researchStack(researchStack));
+    public AssemblyLineRecipeBuilder scannerResearch(@Nonnull ItemStack researchStack) {
+        return scannerResearch(b -> new ResearchRecipeBuilder.ScannerRecipeBuilder().researchStack(researchStack));
+    }
+
+    /**
+     * Generates a research recipe for the Research Station.
+     */
+    public AssemblyLineRecipeBuilder stationResearch(UnaryOperator<ResearchRecipeBuilder.StationRecipeBuilder> research) {
+        ResearchRecipeEntry entry = research.apply(new ResearchRecipeBuilder.StationRecipeBuilder()).build();
+        if (applyResearchProperty(new ResearchPropertyData.ResearchEntry(entry.researchId, entry.dataStack))) {
+            this.recipeEntries.add(entry);
+        }
+        return this;
     }
 
     @Nonnull
@@ -194,95 +199,4 @@ public int getCWUt() {
             return CWUt;
         }
     }
-
-    public static class ResearchBuilder {
-
-        private ItemStack researchStack;
-        private ItemStack dataStack;
-        private String researchId;
-        private int duration;
-        private int eut;
-        private int cwut;
-
-        private ResearchBuilder() {/**/}
-
-        public ResearchBuilder researchStack(@Nonnull ItemStack researchStack) {
-            if (!researchStack.isEmpty()) {
-                this.researchStack = researchStack;
-            }
-            return this;
-        }
-
-        public ResearchBuilder dataStack(@Nonnull ItemStack dataStack) {
-            if (!dataStack.isEmpty()) {
-                this.dataStack = dataStack;
-            }
-            return this;
-        }
-
-        public ResearchBuilder researchId(String researchId) {
-            this.researchId = researchId;
-            return this;
-        }
-
-        public ResearchBuilder duration(int duration) {
-            this.duration = duration;
-            return this;
-        }
-
-        public ResearchBuilder EUt(int eut) {
-            this.eut = eut;
-            return this;
-        }
-
-        /** If this value is greater than zero, then this recipe will be done in the Research Station instead of the Scanner */
-        public ResearchBuilder CWUt(int cwut) {
-            this.cwut = cwut;
-            return this;
-        }
-
-        private ResearchRecipeEntry build() {
-            if (researchStack == null) {
-                throw new IllegalArgumentException("Research stack cannot be null or empty!");
-            }
-
-            if (researchId == null) {
-                researchId = GTStringUtils.itemStackToString(researchStack);
-            }
-
-            if (dataStack == null) {
-                dataStack = cwut > 0
-                        ? AssemblyLineManager.getDefaultResearchStationItem(cwut)
-                        : AssemblyLineManager.getDefaultScannerItem();
-            }
-
-            boolean foundBehavior = false;
-            if (dataStack.getItem() instanceof MetaItem<?> metaItem) {
-                for (IItemBehaviour behaviour : metaItem.getBehaviours(dataStack)) {
-                    if (behaviour instanceof IDataItem) {
-                        foundBehavior = true;
-                        dataStack = dataStack.copy();
-                        dataStack.setCount(1);
-                        break;
-                    }
-                }
-            }
-            if (!foundBehavior) {
-                throw new IllegalArgumentException("Data ItemStack must have the IDataItem behavior");
-            }
-
-            if (duration <= 0) {
-                duration = cwut > 0
-                        ? DEFAULT_STATION_DURATION
-                        : DEFAULT_SCANNER_DURATION;
-            }
-
-            if (eut <= 0) {
-                eut = cwut > 0
-                        ? DEFAULT_STATION_EUT
-                        : DEFAULT_SCANNER_EUT;
-            }
-            return new ResearchRecipeEntry(researchId, researchStack, dataStack, duration, eut, cwut);
-        }
-    }
 }

src/main/java/gregtech/api/recipes/builders/ComputationRecipeBuilder.java

@@ -4,6 +4,7 @@
 import gregtech.api.recipes.RecipeBuilder;
 import gregtech.api.recipes.RecipeMap;
 import gregtech.api.recipes.recipeproperties.ComputationProperty;
+import gregtech.api.recipes.recipeproperties.TotalComputationProperty;
 import gregtech.api.util.EnumValidationResult;
 import gregtech.api.util.GTLog;
 import org.jetbrains.annotations.NotNull;
@@ -31,6 +32,10 @@ public boolean applyProperty(@NotNull String key, Object value) {
             this.CWUt(((Number) value).intValue());
             return true;
         }
+        if (key.equals(TotalComputationProperty.KEY)) {
+            this.totalCWU(((Number) value).intValue());
+            return true;
+        }
         return super.applyProperty(key, value);
     }
 
@@ -42,4 +47,16 @@ public ComputationRecipeBuilder CWUt(int cwut) {
         this.applyProperty(ComputationProperty.getInstance(), cwut);
         return this;
     }
+
+    /**
+     * The total computation for this recipe. If desired, this should be used instead of a call to duration().
+     */
+    public ComputationRecipeBuilder totalCWU(int totalCWU) {
+        if (totalCWU < 0) {
+            GTLog.logger.error("Total CWU cannot be less than 0", new IllegalArgumentException());
+            recipeStatus = EnumValidationResult.INVALID;
+        }
+        this.applyProperty(TotalComputationProperty.getInstance(), totalCWU);
+        return duration(totalCWU);
+    }
 }