Force load BlockStates on startup

Author: Swedz

src/client/java/aztech/modern_industrialization/compat/viewer/usage/MultiblockCategory.java

@@ -95,7 +95,7 @@ public Recipe(ResourceLocation controller, ShapeTemplate shapeTemplate, @Nullabl
             for (var entry : shapeTemplate.members().entrySet()) {
                 // TODO SWEDZ MULTIBLOCKS: account for nbt
                 MultiblockMemberState state = entry.getValue().getPreviewState();
-                Item item = state.blockState().getBlock().asItem();
+                Item item = state.state().getBlock().asItem();
                 if (item != Items.AIR) {
                     materials.put(item, 1 + materials.getOrDefault(item, 0));
                 }

src/client/java/aztech/modern_industrialization/machines/multiblocks/MultiblockErrorHighlight.java

@@ -74,7 +74,7 @@ private static void end(RenderLevelStageEvent event) {
                     RenderHelper.drawCube(poseStack, immediate, 1, 50f / 256, 50f / 256, 15728880, OverlayTexture.NO_OVERLAY);
                 } else {
                     // TODO SWEDZ MULTIBLOCKS: account for nbt + rotation
-                    Minecraft.getInstance().getBlockRenderer().renderSingleBlock(state.blockState(), poseStack, immediate, 15728880,
+                    Minecraft.getInstance().getBlockRenderer().renderSingleBlock(state.state(), poseStack, immediate, 15728880,
                             OverlayTexture.NO_OVERLAY);
                 }
 

src/main/java/aztech/modern_industrialization/guidebook/MultiblockShapeCompiler.java

@@ -80,7 +80,7 @@ public void compile(GuidebookScene scene, PageCompiler compiler, LytErrorSink er
 
                 List<Component> tooltipLines = new ArrayList<>();
                 // Add name of the block because the annotation overrides the usual tooltip
-                tooltipLines.add(member.getPreviewState().blockState().getBlock().getName());
+                tooltipLines.add(member.getPreviewState().state().getBlock().getName());
 
                 tooltipLines.add(MIText.AcceptsHatches.text());
                 var flags = hatchMember.hatchFlags();

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/ShapeTemplate.java

@@ -23,26 +23,49 @@
  */
 package aztech.modern_industrialization.machines.multiblocks.shape;
 
+import aztech.modern_industrialization.MI;
 import aztech.modern_industrialization.machines.models.MachineCasing;
 import aztech.modern_industrialization.machines.multiblocks.shape.member.MultiblockMember;
 import aztech.modern_industrialization.machines.multiblocks.shape.member.SimpleMultiblockMember;
 import java.util.*;
 import net.minecraft.core.BlockPos;
+import net.neoforged.bus.api.SubscribeEvent;
+import net.neoforged.fml.common.EventBusSubscriber;
+import net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent;
 import org.jetbrains.annotations.Nullable;
 
 /**
  * An immutable description of a multiblock shape.
  */
+@EventBusSubscriber(modid = MI.ID, bus = EventBusSubscriber.Bus.MOD)
 public final class ShapeTemplate {
+    private static final List<ShapeTemplate> templates = new ArrayList<>();
+
     private final Map<BlockPos, MultiblockMember> members = new HashMap<>();
 
     private ShapeTemplate() {
+        templates.add(this);
     }
 
     public Map<BlockPos, MultiblockMember> members() {
         return Collections.unmodifiableMap(members);
     }
 
+    /**
+     * Forces all lazy block states in structures to get loaded during startup as soon as blocks are in the registry.
+     * This prevents any delay later where we otherwise would need to be parsing json elements during play. It also
+     * ensures that we get consistent results (e.g. if a file changes during play).
+     */
+    @SubscribeEvent
+    private static void onSetup(FMLCommonSetupEvent event) {
+        for (ShapeTemplate template : templates) {
+            for (var member : template.members().values()) {
+                member.forceLoad();
+            }
+        }
+        MI.LOGGER.info("Initialized {} multiblock shapes", templates.size());
+    }
+
     public static class Builder {
         private final ShapeTemplate template;
         private final MachineCasing hatchCasing;

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/member/MultiblockMember.java

@@ -78,6 +78,8 @@ public static HatchMultiblockMember hatch(SimpleMultiblockMember parent, Machine
         return new HatchMultiblockMember(parent.preview(), parent.tests(), casing, hatchFlags);
     }
 
+    public abstract void forceLoad();
+
     // TODO SWEDZ MULTIBLOCKS: account for nbt
     public abstract boolean matchesState(BlockState state);
 

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/member/MultiblockMemberState.java

@@ -49,13 +49,13 @@ public MultiblockMemberState(BlockStateParser.BlockResult result) {
         this(Lazy.of(result::blockState));
     }
 
-    public BlockState blockState() {
+    public BlockState state() {
         return lazyState.get();
     }
 
     // TODO SWEDZ MULTIBLOCKS: account for nbt + rotation
     // TODO SWEDZ MULTIBLOCKS: boolean field for if we want the structure block
     public void setBlock(Level level, BlockPos pos) {
-        level.setBlockAndUpdate(pos, this.blockState());
+        level.setBlockAndUpdate(pos, this.state());
     }
 }

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/member/SimpleMultiblockMember.java

@@ -48,6 +48,14 @@ public List<MultiblockMemberTest> tests() {
         return tests;
     }
 
+    @Override
+    public void forceLoad() {
+        preview.state();
+        for (var test : tests) {
+            test.forceLoad();
+        }
+    }
+
     @Override
     public boolean matchesState(BlockState state) {
         for (var test : tests) {

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/test/BlockMultiblockMemberTest.java

@@ -34,6 +34,11 @@ public BlockMultiblockMemberTest(Lazy<? extends Block> block) {
         this.block = block;
     }
 
+    @Override
+    public void forceLoad() {
+        block.get();
+    }
+
     @Override
     public boolean matchesState(BlockState state) {
         return state.is(block.get());

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/test/MultiblockMemberTest.java

@@ -26,6 +26,8 @@
 import net.minecraft.world.level.block.state.BlockState;
 
 public abstract class MultiblockMemberTest {
+    public abstract void forceLoad();
+
     public abstract boolean matchesState(BlockState state);
 
     /**

src/main/java/aztech/modern_industrialization/machines/multiblocks/shape/test/StateMultiblockMemberTest.java

@@ -39,10 +39,17 @@ public StateMultiblockMemberTest(MultiblockMemberState state) {
         this(List.of(state));
     }
 
+    @Override
+    public void forceLoad() {
+        for (var state : states) {
+            state.state();
+        }
+    }
+
     @Override
     public boolean matchesState(BlockState state) {
         for (var other : states) {
-            if (state == other.blockState()) {
+            if (state == other.state()) {
                 return true;
             }
         }