Make it so that structural multiblocks don't tick (structural glass and reactor glass) (#8051)

pupnewfster · web-flow · commit e1b05e980902 · 2024-04-09T08:23:23.000-05:00
diff --git a/src/api/java/mekanism/api/MekanismAPI.java b/src/api/java/mekanism/api/MekanismAPI.java
@@ -29,7 +29,7 @@ private MekanismAPI() {
     /**
      * The version of the api classes - may not always match the mod's version
      */
-    public static final String API_VERSION = "10.5.15";
+    public static final String API_VERSION = "10.5.18";
     /**
      * Mekanism's Mod ID
      */
diff --git a/src/api/java/mekanism/api/NBTConstants.java b/src/api/java/mekanism/api/NBTConstants.java
@@ -123,6 +123,10 @@ private NBTConstants() {
     public static final String FILTER = "filter";
     public static final String FILTERS = "filters";
     public static final String FINISHED = "finished";
+    /**
+     * @since 10.5.18
+     */
+    public static final String FORMED = "formed";
     public static final String FLUID_STORED = "fluid";
     public static final String FLUID_TANKS = "FluidTanks";
     public static final String FOLLOW = "follow";
@@ -135,6 +139,10 @@ private NBTConstants() {
     public static final String GAS_STORED_ALT = "gas1";
     public static final String GAS_STORED_ALT_2 = "gas2";
     public static final String GAS_TANKS = "GasTanks";
+    /**
+     * @since 10.5.18
+     */
+    public static final String GUI = "gui";
     public static final String HANDLE_SOUND = "handleSound";
     public static final String HEAT_CAPACITORS = "HeatCapacitors";
     public static final String HEAT_CAPACITY = "heatCapacity";
diff --git a/src/generators/java/mekanism/generators/common/content/fusion/FusionReactorMultiblockData.java b/src/generators/java/mekanism/generators/common/content/fusion/FusionReactorMultiblockData.java
@@ -33,6 +33,7 @@
 import mekanism.common.lib.multiblock.IValveHandler.ValveData;
 import mekanism.common.lib.multiblock.MultiblockData;
 import mekanism.common.registries.MekanismGases;
+import mekanism.common.tile.prefab.TileEntityStructuralMultiblock;
 import mekanism.common.util.CableUtils;
 import mekanism.common.util.ChemicalUtil;
 import mekanism.common.util.HeatUtils;
@@ -170,6 +171,11 @@ public void onCreated(Level world) {
         deathZone = AABB.encapsulatingFullBlocks(getMinPos().offset(1, 1, 1), getMaxPos().offset(-1, -1, -1));
     }
 
+    @Override
+    public boolean allowsStructuralGuiAccess(TileEntityStructuralMultiblock multiblock) {
+        return false;
+    }
+
     @Override
     public void readUpdateTag(CompoundTag tag) {
         super.readUpdateTag(tag);
diff --git a/src/generators/java/mekanism/generators/common/registries/GeneratorsTileEntityTypes.java b/src/generators/java/mekanism/generators/common/registries/GeneratorsTileEntityTypes.java
@@ -74,7 +74,6 @@ private GeneratorsTileEntityTypes() {
     //Misc
     public static final TileEntityTypeRegistryObject<TileEntityReactorGlass> REACTOR_GLASS = TILE_ENTITY_TYPES
           .mekBuilder(GeneratorsBlocks.REACTOR_GLASS, TileEntityReactorGlass::new)
-          .serverTicker(TileEntityMekanism::tickServer)
           .withSimple(Capabilities.CONFIGURABLE)
           .build();
     //Fission Reactor
diff --git a/src/main/java/mekanism/common/block/basic/BlockStructuralGlass.java b/src/main/java/mekanism/common/block/basic/BlockStructuralGlass.java
@@ -29,12 +29,10 @@ public InteractionResult use(@NotNull BlockState state, @NotNull Level world, @N
         if (tile == null) {
             return InteractionResult.PASS;
         } else if (world.isClientSide) {
-            if (!MekanismUtils.canUseAsWrench(player.getItemInHand(hand))) {
-                if (!tile.structuralGuiAccessAllowed() || !tile.hasFormedMultiblock()) {
-                    //If the block's multiblock doesn't allow gui access via structural multiblocks (for example the evaporation plant),
-                    // or if the multiblock is not formed then pass
-                    return InteractionResult.PASS;
-                }
+            if (!MekanismUtils.canUseAsWrench(player.getItemInHand(hand)) && !tile.structuralGuiAccessAllowed()) {
+                //If the block's multiblock doesn't allow gui access via structural multiblocks (for example the evaporation plant),
+                // or if the multiblock is not formed then pass
+                return InteractionResult.PASS;
             }
             return InteractionResult.SUCCESS;
         }
diff --git a/src/main/java/mekanism/common/content/boiler/BoilerMultiblockData.java b/src/main/java/mekanism/common/content/boiler/BoilerMultiblockData.java
@@ -30,6 +30,7 @@
 import mekanism.common.inventory.container.sync.dynamic.ContainerSync;
 import mekanism.common.lib.multiblock.IValveHandler;
 import mekanism.common.lib.multiblock.MultiblockData;
+import mekanism.common.lib.multiblock.Structure;
 import mekanism.common.registries.MekanismGases;
 import mekanism.common.tile.multiblock.TileEntityBoilerCasing;
 import mekanism.common.tile.multiblock.TileEntityBoilerValve;
@@ -136,9 +137,9 @@ public void onCreated(Level world) {
     }
 
     @Override
-    public void remove(Level world) {
+    public void remove(Level world, Structure oldStructure) {
         hotMap.removeBoolean(inventoryID);
-        super.remove(world);
+        super.remove(world, oldStructure);
     }
 
     @Override
diff --git a/src/main/java/mekanism/common/content/evaporation/EvaporationMultiblockData.java b/src/main/java/mekanism/common/content/evaporation/EvaporationMultiblockData.java
@@ -34,13 +34,15 @@
 import mekanism.common.inventory.slot.OutputInventorySlot;
 import mekanism.common.lib.multiblock.IValveHandler;
 import mekanism.common.lib.multiblock.MultiblockData;
+import mekanism.common.lib.multiblock.Structure;
 import mekanism.common.recipe.IMekanismRecipeTypeProvider;
 import mekanism.common.recipe.MekanismRecipeType;
 import mekanism.common.recipe.lookup.ISingleRecipeLookupHandler.FluidRecipeLookupHandler;
 import mekanism.common.recipe.lookup.cache.InputRecipeCache.SingleFluid;
 import mekanism.common.recipe.lookup.monitor.RecipeCacheLookupMonitor;
 import mekanism.common.tile.multiblock.TileEntityThermalEvaporationBlock;
 import mekanism.common.tile.prefab.TileEntityRecipeMachine;
+import mekanism.common.tile.prefab.TileEntityStructuralMultiblock;
 import mekanism.common.util.MekanismUtils;
 import mekanism.common.util.NBTUtils;
 import net.minecraft.core.BlockPos;
@@ -158,6 +160,11 @@ public boolean tick(Level world) {
         return needsPacket;
     }
 
+    @Override
+    public boolean allowsStructuralGuiAccess(TileEntityStructuralMultiblock multiblock) {
+        return false;
+    }
+
     @Override
     public void readUpdateTag(CompoundTag tag) {
         super.readUpdateTag(tag);
@@ -302,9 +309,9 @@ protected int getMultiblockRedstoneLevel() {
     }
 
     @Override
-    public void remove(Level world) {
+    public void remove(Level world, Structure oldStructure) {
         //Clear the cached solar panels so that we don't hold references to them and prevent them from being able to be garbage collected
         cachedSolar.clear();
-        super.remove(world);
+        super.remove(world, oldStructure);
     }
 }
diff --git a/src/main/java/mekanism/common/content/matrix/MatrixMultiblockData.java b/src/main/java/mekanism/common/content/matrix/MatrixMultiblockData.java
@@ -12,6 +12,7 @@
 import mekanism.common.lib.multiblock.IValveHandler.ValveData;
 import mekanism.common.lib.multiblock.MultiblockCache.CacheSubstance;
 import mekanism.common.lib.multiblock.MultiblockData;
+import mekanism.common.lib.multiblock.Structure;
 import mekanism.common.tile.multiblock.TileEntityInductionCasing;
 import mekanism.common.tile.multiblock.TileEntityInductionCell;
 import mekanism.common.tile.multiblock.TileEntityInductionPort;
@@ -112,9 +113,9 @@ public boolean tick(Level world) {
     }
 
     @Override
-    public void remove(Level world) {
+    public void remove(Level world, Structure oldStructure) {
         energyContainer.invalidate();
-        super.remove(world);
+        super.remove(world, oldStructure);
     }
 
     @Override
diff --git a/src/main/java/mekanism/common/lib/multiblock/FormationProtocol.java b/src/main/java/mekanism/common/lib/multiblock/FormationProtocol.java
@@ -93,9 +93,9 @@ public FormationResult doUpdate() {
             // In theory we could partially get around this issue by keeping track of all the positions for the multiblock in the cache and only
             // reuse the id if we contain all elements we previously had, but doing so is not currently worth all the extra checks
             UUID idToUse = manager.getUniqueInventoryID();
-            if (!result.idsFound.isEmpty()) {
+            if (!result.idsFound().isEmpty()) {
                 RejectContents rejectContents = new RejectContents();
-                for (Map.Entry<UUID, MultiblockCache<T>> entry : result.idsFound.entrySet()) {
+                for (Map.Entry<UUID, MultiblockCache<T>> entry : result.idsFound().entrySet()) {
                     if (cache == null) {
                         cache = entry.getValue();
                     } else {
@@ -105,6 +105,7 @@ public FormationResult doUpdate() {
                 //Replace the caches for all the old ids with a singular merged cache with our desired id
                 manager.replaceCaches(result.idsFound().keySet(), idToUse, cache);
                 if (!rejectContents.rejectedItems.isEmpty()) {
+                    //TODO - 1.20.4: Don't drop it in the center if there is no nearest player, maybe drop it on top of the multiblock? Or to one of the sides
                     Vec3 dropPosition = pointerPos.getCenter();
                     //Try to see which player was nearest to multiblocks that have rejected items
                     Player nearestPlayer = world.getNearestPlayer(dropPosition.x, dropPosition.y, dropPosition.z, 25, true);
diff --git a/src/main/java/mekanism/common/lib/multiblock/IStructuralMultiblock.java b/src/main/java/mekanism/common/lib/multiblock/IStructuralMultiblock.java
@@ -15,4 +15,8 @@ public interface IStructuralMultiblock extends IMultiblockBase {
      * evaporation plant.
      */
     boolean structuralGuiAccessAllowed();
+
+    void multiblockUnformed(Structure structure);
+
+    void multiblockFormed(MultiblockData multiblock);
 }
diff --git a/src/main/java/mekanism/common/lib/multiblock/MultiblockData.java b/src/main/java/mekanism/common/lib/multiblock/MultiblockData.java
@@ -42,6 +42,7 @@
 import mekanism.common.lib.multiblock.IValveHandler.ValveData;
 import mekanism.common.lib.multiblock.MultiblockCache.CacheSubstance;
 import mekanism.common.tile.prefab.TileEntityMultiblock;
+import mekanism.common.tile.prefab.TileEntityStructuralMultiblock;
 import mekanism.common.util.EnumUtils;
 import mekanism.common.util.NBTUtils;
 import mekanism.common.util.WorldUtils;
@@ -145,6 +146,14 @@ public void markDirty() {
         dirty = true;
     }
 
+    /**
+     * Returns true if the multiblock's gui can be accessed via structural multiblocks, false otherwise. An example this may be false for would be on a thermal
+     * evaporation plant.
+     */
+    public boolean allowsStructuralGuiAccess(TileEntityStructuralMultiblock multiblock) {
+        return true;
+    }
+
     /**
      * Tick the multiblock.
      *
@@ -206,6 +215,12 @@ public void onCreated(Level world) {
                 internalMultiblock.setMultiblock(this);
             }
         }
+        for (BlockPos pos : locations) {
+            BlockEntity tile = WorldUtils.getTileEntity(world, pos);
+            if (tile instanceof IStructuralMultiblock structuralMultiblock) {
+                structuralMultiblock.multiblockFormed(this);
+            }
+        }
 
         if (shouldCap(CacheSubstance.FLUID)) {
             for (IExtendedFluidTank tank : getFluidTanks(null)) {
@@ -256,13 +271,19 @@ protected boolean shouldCap(CacheSubstance<?, ?> type) {
         return true;
     }
 
-    public void remove(Level world) {
+    public void remove(Level world, Structure oldStructure) {
         for (BlockPos pos : internalLocations) {
             BlockEntity tile = WorldUtils.getTileEntity(world, pos);
             if (tile instanceof IInternalMultiblock internalMultiblock) {
                 internalMultiblock.setMultiblock(null);
             }
         }
+        for (BlockPos pos : locations) {
+            BlockEntity tile = WorldUtils.getTileEntity(world, pos);
+            if (tile instanceof IStructuralMultiblock structuralMultiblock) {
+                structuralMultiblock.multiblockUnformed(oldStructure);
+            }
+        }
         inventoryID = null;
         formed = false;
         recheckStructure = false;
diff --git a/src/main/java/mekanism/common/lib/multiblock/MultiblockManager.java b/src/main/java/mekanism/common/lib/multiblock/MultiblockManager.java
@@ -77,6 +77,11 @@ public String getNameLower() {
         return nameLower;
     }
 
+    @Override
+    public String toString() {
+        return name;
+    }
+
     public boolean isCompatible(BlockEntity tile) {
         if (tile instanceof IMultiblock<?> multiblock) {
             return multiblock.getManager() == this;
diff --git a/src/main/java/mekanism/common/lib/multiblock/Structure.java b/src/main/java/mekanism/common/lib/multiblock/Structure.java
@@ -216,7 +216,7 @@ public void invalidate(Level world) {
 
     public void removeMultiblock(Level world) {
         if (multiblockData != null) {
-            multiblockData.remove(world);
+            multiblockData.remove(world, this);
             multiblockData = null;
         }
     }
@@ -247,33 +247,23 @@ private static void validate(IMultiblockBase node, Long2ObjectMap<ChunkAccess> c
             if (tile instanceof IMultiblockBase adj && isCompatible(n, adj)) {
                 boolean didMerge = false;
                 if (n instanceof IStructuralMultiblock structuralN && adj instanceof IStructuralMultiblock structuralAdj) {
-                    Set<MultiblockManager<?>> managers = new HashSet<>();
-                    managers.addAll(structuralN.getStructureMap().keySet());
+                    Set<MultiblockManager<?>> managers = new HashSet<>(structuralN.getStructureMap().keySet());
                     managers.addAll(structuralAdj.getStructureMap().keySet());
-                    // if both are structural, they should merge all manager structures
-                    //TODO - 1.18: Figure out what this should be as having it just be equals seems incorrect.
-                    // My guess is it should be the commented code down below but maybe it should be |= instead
+                    // if both are structural, they try to merge all manager structures
                     for (MultiblockManager<?> manager : managers) {
-                        didMerge = mergeIfNecessary(n, adj, manager);
+                        didMerge |= mergeIfNecessary(n, adj, manager, true);
                     }
-                    /*if (!managers.isEmpty()) {
-                        boolean merged = true;
-                        for (MultiblockManager<?> manager : managers) {
-                            merged &= mergeIfNecessary(n, adj, manager);
-                        }
-                        didMerge = merged;
-                    }*/
                 } else if (n instanceof IStructuralMultiblock) {
                     // validate from the perspective of the IMultiblock
                     if (!hasStructure(n, (IMultiblock<?>) adj)) {
                         validate(adj, chunks);
                     }
                     return false;
                 } else if (adj instanceof IStructuralMultiblock) {
-                    didMerge = mergeIfNecessary(n, adj, getManager(n));
+                    didMerge = mergeIfNecessary(n, adj, getManager(n), false);
                 } else { // both are regular IMultiblocks
                     // we know the structures are compatible so managers must be the same for both
-                    didMerge = mergeIfNecessary(n, adj, getManager(n));
+                    didMerge = mergeIfNecessary(n, adj, getManager(n), false);
                 }
                 return didMerge;
             }
@@ -285,7 +275,7 @@ private static boolean hasStructure(IMultiblockBase structural, IMultiblock<?> m
         return structural.getStructure(multiblock.getManager()) == multiblock.getStructure();
     }
 
-    private static boolean mergeIfNecessary(IMultiblockBase node, IMultiblockBase adj, MultiblockManager<?> manager) {
+    private static boolean mergeIfNecessary(IMultiblockBase node, IMultiblockBase adj, MultiblockManager<?> manager, boolean bothStructural) {
         // reset the structures if they're invalid
         Structure nodeStructure = node.getStructure(manager);
         if (!nodeStructure.isValid()) {
@@ -297,6 +287,14 @@ private static boolean mergeIfNecessary(IMultiblockBase node, IMultiblockBase ad
         }
         // only merge if the structures are different
         if (!node.hasStructure(adjStructure)) {
+            if (bothStructural) {
+                //If at least one is formed, but they aren't both formed then don't merge them
+                // as it means we are placing a structural multiblock against another structural one that is already formed,
+                // so it has to be outside the bounds
+                if ((nodeStructure.getMultiblockData() == null) == (adjStructure.getMultiblockData() != null)) {
+                    return false;
+                }
+            }
             Structure changed;
             // merge into the bigger structure for efficiency
             if (nodeStructure.size() >= adjStructure.size() || (nodeStructure.getManager() != null && adjStructure.getManager() == null)) {
diff --git a/src/main/java/mekanism/common/registries/MekanismTileEntityTypes.java b/src/main/java/mekanism/common/registries/MekanismTileEntityTypes.java
@@ -392,7 +392,6 @@ private static void registerFactory(FactoryTier tier, FactoryType type, BlockEnt
           .build();
     public static final TileEntityTypeRegistryObject<TileEntityStructuralGlass> STRUCTURAL_GLASS = TILE_ENTITY_TYPES
           .mekBuilder(MekanismBlocks.STRUCTURAL_GLASS, TileEntityStructuralGlass::new)
-          .serverTicker(TileEntityMekanism::tickServer)
           .withSimple(Capabilities.CONFIGURABLE)
           .build();
     public static final TileEntityTypeRegistryObject<TileEntitySuperheatingElement> SUPERHEATING_ELEMENT = TILE_ENTITY_TYPES.mekBuilder(MekanismBlocks.SUPERHEATING_ELEMENT, TileEntitySuperheatingElement::new)
diff --git a/src/main/java/mekanism/common/tile/prefab/TileEntityStructuralMultiblock.java b/src/main/java/mekanism/common/tile/prefab/TileEntityStructuralMultiblock.java

Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,8 @@ public interface IStructuralMultiblock extends IMultiblockBase {`
`15`	`15`	`* evaporation plant.`
`16`	`16`	`*/`
`17`	`17`	`boolean structuralGuiAccessAllowed();`
	`18`	`+`
	`19`	`+ void multiblockUnformed(Structure structure);`
	`20`	`+`
	`21`	`+ void multiblockFormed(MultiblockData multiblock);`
`18`	`22`	`}`