Rework FuelRecipeLogic (#166)

ALongStringOfNumbers · web-flow · commit d2db22526240 · 2021-10-24T20:12:00.000-04:00
* Rework FuelRecipeLogic

* Fix JEI display for turbines

* Try to address notifiable feedback

* Some review feedback

* Feedback changes
diff --git a/src/main/java/gregtech/api/capability/IMultiblockController.java b/src/main/java/gregtech/api/capability/IMultiblockController.java
@@ -3,4 +3,8 @@
 public interface IMultiblockController {
 
     boolean isStructureFormed();
+
+    default boolean isStructureObstructed() {
+        return false;
+    }
 }
diff --git a/src/main/java/gregtech/api/capability/impl/FuelRecipeLogic.java b/src/main/java/gregtech/api/capability/impl/FuelRecipeLogic.java
@@ -5,6 +5,7 @@
 import gregtech.api.metatileentity.MTETrait;
 import gregtech.api.metatileentity.MetaTileEntity;
 import gregtech.api.metatileentity.multiblock.MultiblockWithDisplayBase;
+import gregtech.api.multiblock.IMaintenance;
 import gregtech.api.recipes.machines.FuelRecipeMap;
 import gregtech.api.recipes.recipes.FuelRecipe;
 import gregtech.api.util.GTUtility;
@@ -35,6 +36,7 @@ public class FuelRecipeLogic extends MTETrait implements IControllable, IFuelabl
     private boolean isActive;
     private boolean workingEnabled = true;
     private boolean wasActiveAndNeedsUpdate = false;
+    protected boolean invalidInputsForRecipes;
 
     public FuelRecipeLogic(MetaTileEntity metaTileEntity, FuelRecipeMap recipeMap, Supplier<IEnergyContainer> energyContainer, Supplier<IMultipleTankHandler> fluidTank, long maxVoltage) {
         super(metaTileEntity);
@@ -108,20 +110,43 @@ public <T> T getCapability(Capability<T> capability) {
         return null;
     }
 
+    protected boolean hasNotifiedInputs() {
+        return metaTileEntity.getNotifiedFluidInputList().size() > 0;
+    }
+
+    protected boolean canWorkWithInputs() {
+        // if the inputs were bad last time, check if they've changed before trying to find a new recipe.
+        if (this.invalidInputsForRecipes && !hasNotifiedInputs()) return false;
+        else {
+            this.invalidInputsForRecipes = false;
+        }
+        return true;
+    }
+
     @Override
     public void update() {
-        if (getMetaTileEntity().getWorld().isRemote) return;
+        if (getMetaTileEntity().getWorld().isRemote) {
+            return;
+        }
+
         if (workingEnabled) {
             if (recipeDurationLeft > 0) {
-                if (energyContainer.get().getEnergyCanBeInserted() >=
-                        recipeOutputVoltage || shouldVoidExcessiveEnergy()) {
+                //Check for if the full energy amount can be added to the output container, or if the energy should be voided
+                //In addition, checks if the recipe should be canceled for any reason (Once per second)
+                if ((energyContainer.get().getEnergyCanBeInserted() >= recipeOutputVoltage || shouldVoidExcessiveEnergy())
+                        && (metaTileEntity.getOffsetTimer() % 20 == 0 && !isObstructed())) {
                     energyContainer.get().addEnergy(recipeOutputVoltage);
+                    //If the recipe has finished, mark the machine as needing to be updated
                     if (--this.recipeDurationLeft == 0) {
                         this.wasActiveAndNeedsUpdate = true;
                     }
                 }
+               else if(isObstructed()) {
+                    this.recipeDurationLeft = 0;
+                    this.wasActiveAndNeedsUpdate = true;
+                }
             }
-            if (recipeDurationLeft == 0 && isReadyForRecipes()) {
+            if (recipeDurationLeft == 0 && isReadyForRecipes() && canWorkWithInputs()) {
                 tryAcquireNewRecipe();
             }
         }
@@ -131,24 +156,50 @@ public void update() {
         }
     }
 
+    /**
+     * Whether the multiblock can begin searching for new recipes once a recipe is completed.
+     * This is called only when the multiblock begins searching for new recipes, not during the recipe progression.
+     * This method will also cancel searching for recipes if there are too many maintenance issues.
+     *
+     * @return {@code true} if the multiblock should search for a new recipe
+     */
     protected boolean isReadyForRecipes() {
-        return true;
+        if (metaTileEntity instanceof IMaintenance) {
+
+            IMaintenance controller = (IMaintenance) metaTileEntity;
+
+            // do not run recipes when there are more than 5 maintenance problems
+            if (controller.hasMaintenanceMechanics() && controller.getNumMaintenanceProblems() > 5) {
+                return false;
+            }
+        }
+
+        return !isObstructed();
+    }
+
+    /**
+     * Whether the multiblock should cancel its recipe for any reason.
+     * This will be checked every 20 update ticks, unlike {@link FuelRecipeLogic#isReadyForRecipes()}
+     * Some examples of usage would be if a rotor or air intake is obstructed.
+     *
+     * @return {@code true} if the multiblock should cancel its recipe for any reason
+     */
+    protected boolean isObstructed() {
+        return false;
     }
 
     protected boolean shouldVoidExcessiveEnergy() {
         return false;
     }
 
+    /**
+     * Search the combined Fluid Inventory to find a valid fluid for running the power generation recipe.
+     */
     private void tryAcquireNewRecipe() {
-        if (metaTileEntity instanceof MultiblockWithDisplayBase) {
-
-            MultiblockWithDisplayBase controller = (MultiblockWithDisplayBase) metaTileEntity;
-
-            // do not run recipes when there are more than 5 maintenance problems
-            if (controller.hasMaintenanceMechanics() && controller.getNumMaintenanceProblems() > 5)
-                return;
-        }
 
+        // Set this here to avoid it being updated multiple time in the loop through the fluid tanks.
+        // It will get reset if a valid recipe is found
+        this.invalidInputsForRecipes = true;
         IMultipleTankHandler fluidTanks = this.fluidTank.get();
         for (IFluidTank fluidTank : fluidTanks) {
             FluidStack tankContents = fluidTank.getFluid();
@@ -164,15 +215,20 @@ private void tryAcquireNewRecipe() {
                             if (controller.hasMufflerMechanics())
                                 controller.outputRecoveryItems();
 
-                            // increase total on time
+                            // increase total multiblock active time
                             controller.calculateMaintenance(previousRecipe.getDuration());
                         }
                     }
 
+                    // If we have successfully found a recipe, update the variable before leaving the loop
+                    this.invalidInputsForRecipes = false;
                     break; //recipe is found and ready to use
                 }
             }
         }
+
+        // Clear notified Fluid input list, either after successfully finding a recipe, or failure to find a recipe
+        metaTileEntity.getNotifiedFluidInputList().clear();
     }
 
     public boolean isActive() {
@@ -181,9 +237,9 @@ public boolean isActive() {
 
     private int tryAcquireNewRecipe(FluidStack fluidStack) {
         FuelRecipe currentRecipe;
-        if (previousRecipe != null && previousRecipe.matches(getMaxVoltage(), fluidStack)) {
+        if (this.previousRecipe != null && this.previousRecipe.matches(getMaxVoltage(), fluidStack)) {
             //if previous recipe still matches inputs, try to use it
-            currentRecipe = previousRecipe;
+            currentRecipe = this.previousRecipe;
         } else {
             //else, try searching new recipe for given inputs
             currentRecipe = recipeMap.findRecipe(getMaxVoltage(), fluidStack);
@@ -192,9 +248,13 @@ private int tryAcquireNewRecipe(FluidStack fluidStack) {
                 this.previousRecipe = currentRecipe;
             }
         }
+
+        //Check if we have found a valid recipe
         if (currentRecipe != null && checkRecipe(currentRecipe)) {
             int fuelAmountToUse = calculateFuelAmount(currentRecipe);
+            //Check if we have the required amount of fuel, and optionally boosters
             if (fluidStack.amount >= fuelAmountToUse) {
+                //Initialize the required variables. This is basically setupRecipe in AbstractRecipeLogic, just condensed
                 this.recipeDurationLeft = calculateRecipeDuration(currentRecipe);
                 this.recipeOutputVoltage = startRecipe(currentRecipe, fuelAmountToUse, recipeDurationLeft);
                 if (wasActiveAndNeedsUpdate) {
diff --git a/src/main/java/gregtech/api/multiblock/IMaintenance.java b/src/main/java/gregtech/api/multiblock/IMaintenance.java
@@ -11,4 +11,6 @@ public interface IMaintenance {
     void setMaintenanceFixed(int index);
 
     void storeTaped(boolean isTaped);
+
+    boolean hasMaintenanceMechanics();
 }
diff --git a/src/main/java/gregtech/common/metatileentities/electric/multiblockpart/MetaTileEntityRotorHolder.java b/src/main/java/gregtech/common/metatileentities/electric/multiblockpart/MetaTileEntityRotorHolder.java
@@ -108,6 +108,7 @@ public boolean isFrontFaceFree() {
 
     private boolean checkTurbineFaceFree() {
         EnumFacing facing = getFrontFacing();
+        //TODO, this also needs to check Y for freedom wrench implementation
         boolean permuteXZ = facing.getAxis() == Axis.Z;
         BlockPos centerPos = getPos().offset(facing);
         for (int x = -1; x < 2; x++) {
diff --git a/src/main/java/gregtech/common/metatileentities/multi/electric/generator/LargeCombustionEngineWorkableHandler.java b/src/main/java/gregtech/common/metatileentities/multi/electric/generator/LargeCombustionEngineWorkableHandler.java
@@ -4,10 +4,14 @@
 import gregtech.api.capability.IMultipleTankHandler;
 import gregtech.api.capability.impl.FuelRecipeLogic;
 import gregtech.api.metatileentity.MetaTileEntity;
+import gregtech.api.metatileentity.multiblock.MultiblockWithDisplayBase;
 import gregtech.api.recipes.machines.FuelRecipeMap;
 import gregtech.api.recipes.recipes.FuelRecipe;
 import gregtech.api.unification.material.Materials;
+import net.minecraft.block.state.IBlockState;
 import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.util.EnumFacing;
+import net.minecraft.util.math.BlockPos;
 import net.minecraftforge.fluids.FluidStack;
 
 import java.util.function.Supplier;
@@ -34,6 +38,7 @@ public FluidStack getFuelStack() {
     protected boolean checkRecipe(FuelRecipe recipe) {
         FluidStack lubricantStack = Materials.Lubricant.getFluid(2);
         FluidStack drainStack = fluidTank.get().drain(lubricantStack, false);
+        //TODO, shouldn't this be &&?
         return (drainStack != null && drainStack.amount >= 2) || currentCycle < maxCycleLength;
     }
 
@@ -71,4 +76,35 @@ public void deserializeNBT(NBTTagCompound compound) {
         super.deserializeNBT(compound);
         this.currentCycle = compound.getInteger("Cycle");
     }
+
+    @Override
+    protected boolean isObstructed() {
+        return checkIntakesObstructed();
+    }
+
+    private boolean checkIntakesObstructed() {
+        if(this.metaTileEntity instanceof MultiblockWithDisplayBase) {
+            MultiblockWithDisplayBase controller = (MultiblockWithDisplayBase) this.metaTileEntity;
+
+            EnumFacing facing = controller.getFrontFacing();
+            //TODO, this also needs to check Y for freedom wrench implementation
+            boolean permuteXZ = facing.getAxis() == EnumFacing.Axis.Z;
+            BlockPos centerPos = controller.getPos().offset(facing);
+            for (int x = -1; x < 2; x++) {
+                for (int y = -1; y < 2; y++) {
+                    //Skip the controller block itself
+                    if(x == 0 && y == 0) {
+                        continue;
+                    }
+                    BlockPos blockPos = centerPos.add(permuteXZ ? x : 0, y, permuteXZ ? 0 : x);
+                    IBlockState blockState = controller.getWorld().getBlockState(blockPos);
+                    if (!blockState.getBlock().isAir(blockState, controller.getWorld(), blockPos)) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/main/java/gregtech/common/metatileentities/multi/electric/generator/LargeTurbineWorkableHandler.java b/src/main/java/gregtech/common/metatileentities/multi/electric/generator/LargeTurbineWorkableHandler.java
@@ -79,7 +79,7 @@ public long getMaxVoltage() {
     @Override
     protected boolean isReadyForRecipes() {
         MetaTileEntityRotorHolder rotorHolder = largeTurbine.getAbilities(MultiblockAbility.ABILITY_ROTOR_HOLDER).get(0);
-        return rotorHolder.isHasRotor();
+        return rotorHolder.isHasRotor() && super.isReadyForRecipes();
     }
 
     @Override
@@ -145,4 +145,9 @@ public void deserializeNBT(NBTTagCompound compound) {
     protected boolean shouldVoidExcessiveEnergy() {
         return true;
     }
+
+    @Override
+    protected boolean isObstructed() {
+        return !largeTurbine.isRotorFaceFree();
+    }
 }
diff --git a/src/main/java/gregtech/common/metatileentities/multi/electric/generator/MetaTileEntityLargeCombustionEngine.java b/src/main/java/gregtech/common/metatileentities/multi/electric/generator/MetaTileEntityLargeCombustionEngine.java
@@ -7,7 +7,6 @@
 import gregtech.api.metatileentity.multiblock.IMultiblockPart;
 import gregtech.api.metatileentity.multiblock.MultiblockAbility;
 import gregtech.api.multiblock.BlockPattern;
-import gregtech.api.multiblock.BlockWorldState;
 import gregtech.api.multiblock.FactoryBlockPattern;
 import gregtech.api.recipes.RecipeMaps;
 import gregtech.api.render.ICubeRenderer;
@@ -21,12 +20,13 @@
 import net.minecraft.block.state.IBlockState;
 import net.minecraft.util.ResourceLocation;
 import net.minecraft.util.text.ITextComponent;
+import net.minecraft.util.text.Style;
 import net.minecraft.util.text.TextComponentTranslation;
+import net.minecraft.util.text.TextFormatting;
 import net.minecraftforge.fluids.FluidStack;
 
 import javax.annotation.Nonnull;
 import java.util.List;
-import java.util.function.Predicate;
 
 public class MetaTileEntityLargeCombustionEngine extends FueledMultiblockController {
 
@@ -64,20 +64,15 @@ protected void addDisplayText(List<ITextComponent> textList) {
             textList.add(new TextComponentTranslation("gregtech.multiblock.large_combustion_engine.fuel_amount", fuelAmount, fuelName));
             textList.add(new TextComponentTranslation("gregtech.multiblock.large_combustion_engine.oxygen_amount", oxygenAmount));
             textList.add(new TextComponentTranslation(oxygenAmount >= 2 ? "gregtech.multiblock.large_combustion_engine.oxygen_boosted" : "gregtech.multiblock.large_combustion_engine.supply_oxygen_to_boost"));
+
+            if(isStructureObstructed()) {
+                textList.add(new TextComponentTranslation("gregtech.multiblock.turbine.obstructed")
+                        .setStyle(new Style().setColor(TextFormatting.RED)));
+            }
         }
         super.addDisplayText(textList);
     }
 
-    protected Predicate<BlockWorldState> intakeCasingPredicate() {
-        IBlockState blockState = MetaBlocks.MULTIBLOCK_CASING.getState(MultiblockCasingType.ENGINE_INTAKE_CASING);
-        return blockWorldState -> {
-            if (blockWorldState.getBlockState() != blockState)
-                return false;
-            IBlockState offsetState = blockWorldState.getOffsetState(getFrontFacing());
-            return offsetState.getBlock().isAir(offsetState, blockWorldState.getWorld(), blockWorldState.getPos());
-        };
-    }
-
     @Override
     protected BlockPattern createStructurePattern() {
         return FactoryBlockPattern.start()
@@ -89,7 +84,7 @@ protected BlockPattern createStructurePattern() {
                 .where('G', statePredicate(MetaBlocks.TURBINE_CASING.getState(TurbineCasingType.TITANIUM_GEARBOX)))
                 .where('C', statePredicate(getCasingState()).or(abilityPartPredicate(ALLOWED_ABILITIES)))
                 .where('D', abilityPartPredicate(MultiblockAbility.OUTPUT_ENERGY))
-                .where('A', intakeCasingPredicate())
+                .where('A', statePredicate(MetaBlocks.MULTIBLOCK_CASING.getState(MultiblockCasingType.ENGINE_INTAKE_CASING)))
                 .where('Y', selfPredicate())
                 .build();
     }
@@ -113,4 +108,9 @@ protected OrientedOverlayRenderer getFrontOverlay() {
     public boolean hasMufflerMechanics() {
         return true;
     }
+
+    @Override
+    public boolean isStructureObstructed() {
+        return ((LargeCombustionEngineWorkableHandler) workableHandler).isObstructed();
+    }
 }
diff --git a/src/main/java/gregtech/common/metatileentities/multi/electric/generator/MetaTileEntityLargeTurbine.java b/src/main/java/gregtech/common/metatileentities/multi/electric/generator/MetaTileEntityLargeTurbine.java
@@ -190,4 +190,9 @@ protected OrientedOverlayRenderer getFrontOverlay() {
     public boolean hasMufflerMechanics() {
         return turbineType.hasMufflerHatch;
     }
+
+    @Override
+    public boolean isStructureObstructed() {
+        return !isRotorFaceFree();
+    }
 }
diff --git a/src/main/java/gregtech/integration/theoneprobe/provider/MultiblockInfoProvider.java b/src/main/java/gregtech/integration/theoneprobe/provider/MultiblockInfoProvider.java
@@ -19,8 +19,14 @@ protected Capability<IMultiblockController> getCapability() {
     @Override
     protected void addProbeInfo(IMultiblockController capability, IProbeInfo probeInfo, TileEntity tileEntity, EnumFacing sideHit) {
         IProbeInfo horizontalPane = probeInfo.horizontal(probeInfo.defaultLayoutStyle().alignment(ElementAlignment.ALIGN_CENTER));
-        if (capability.isStructureFormed())
+        if (capability.isStructureFormed()) {
             horizontalPane.text(TextStyleClass.INFO + "{*gregtech.top.valid_structure*}");
+            if(capability.isStructureObstructed()) {
+                IProbeInfo horizontalPaneObstructed = probeInfo.horizontal(probeInfo.defaultLayoutStyle().alignment(ElementAlignment.ALIGN_CENTER));
+                horizontalPaneObstructed.text(TextStyleClass.INFO + "{*gregtech.top.obstructed_structure*}");
+            }
+
+        }
         else
             horizontalPane.text(TextStyleClass.INFO + "{*gregtech.top.invalid_structure*}");
     }
diff --git a/src/main/resources/assets/gregtech/lang/en_us.lang b/src/main/resources/assets/gregtech/lang/en_us.lang
@@ -40,6 +40,7 @@ gregtech.top.fuel_none=No fuel
 
 gregtech.top.invalid_structure=§cInvalid Structure
 gregtech.top.valid_structure=§aStructure Formed
+gregtech.top.obstructed_structure=§cStructure Obstructed
 
 gregtech.multiblock.title=Multiblock Pattern
 gregtech.multiblock.primitive_blast_furnace.description=The Primitive Blast Furnace (PBF) is a multiblock structure used for cooking steel in the early game. Although not very fast, it will provide you with steel for your first setups.

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,8 @@`
`3`	`3`	`public interface IMultiblockController {`
`4`	`4`
`5`	`5`	`boolean isStructureFormed();`
	`6`	`+`
	`7`	`+ default boolean isStructureObstructed() {`
	`8`	`+ return false;`
	`9`	`+ }`
`6`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,6 @@ public interface IMaintenance {`
`11`	`11`	`void setMaintenanceFixed(int index);`
`12`	`12`
`13`	`13`	`void storeTaped(boolean isTaped);`
	`14`	`+`
	`15`	`+ boolean hasMaintenanceMechanics();`
`14`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public long getMaxVoltage() {`
`79`	`79`	`@Override`
`80`	`80`	`protected boolean isReadyForRecipes() {`
`81`	`81`	`MetaTileEntityRotorHolder rotorHolder = largeTurbine.getAbilities(MultiblockAbility.ABILITY_ROTOR_HOLDER).get(0);`
`82`		`- return rotorHolder.isHasRotor();`
	`82`	`+ return rotorHolder.isHasRotor() && super.isReadyForRecipes();`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`@Override`
`@@ -145,4 +145,9 @@ public void deserializeNBT(NBTTagCompound compound) {`
`145`	`145`	`protected boolean shouldVoidExcessiveEnergy() {`
`146`	`146`	`return true;`
`147`	`147`	`}`
	`148`	`+`
	`149`	`+ @Override`
	`150`	`+ protected boolean isObstructed() {`
	`151`	`+ return !largeTurbine.isRotorFaceFree();`
	`152`	`+ }`
`148`	`153`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,4 +190,9 @@ protected OrientedOverlayRenderer getFrontOverlay() {`
`190`	`190`	`public boolean hasMufflerMechanics() {`
`191`	`191`	`return turbineType.hasMufflerHatch;`
`192`	`192`	`}`
	`193`	`+`
	`194`	`+ @Override`
	`195`	`+ public boolean isStructureObstructed() {`
	`196`	`+ return !isRotorFaceFree();`
	`197`	`+ }`
`193`	`198`	`}`