Fix initialization of cached block info not working on neoforge

Broken since 1.21.2+

Author: 2No2Name

CHANGELOG.md

@@ -12,3 +12,4 @@ Make sure to take a backup of your world before using the mod and please report
 
 ## Fixes
 - Fix entity explosion exposure optimization not using the entity collision context
+- Fix initialization of cached block info not working on neoforge

build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
 // Fabric: https://fabricmc.net/develop/
 // Neoforge: https://neoforged.net/
 val MINECRAFT_VERSION by extra { "1.21.4" } //MUST manually update fabric.mod.json and neoforge.mods.toml
-val NEOFORGE_VERSION by extra { "21.4.109-beta" }
+val NEOFORGE_VERSION by extra { "21.4.115-beta" }
 val FABRIC_LOADER_VERSION by extra { "0.16.9" }
 val FABRIC_API_VERSION by extra { "0.110.5+1.21.4" }
 

common/src/main/java/net/caffeinemc/mods/lithium/common/initialization/BlockInfoInitializer.java

@@ -0,0 +1,28 @@
+package net.caffeinemc.mods.lithium.common.initialization;
+
+import net.caffeinemc.mods.lithium.common.ai.pathing.BlockStatePathingCache;
+import net.caffeinemc.mods.lithium.common.block.BlockStateFlagHolder;
+import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.state.BlockState;
+
+public class BlockInfoInitializer {
+
+    // Initialize the block info.
+    // This is called before burn times are set in the minecraft server, but we don't care about the updated burn times.
+    // But burn times are updated after block tags etc. are modified, so it is a good hook
+    public static void initializeBlockInfo() {
+        if (BlockStatePathingCache.class.isAssignableFrom(BlockState.class)) {
+            // Initialize / Reinitialize the cached path node types.
+            for (BlockState blockState : Block.BLOCK_STATE_REGISTRY) {
+                ((BlockStatePathingCache) blockState).lithium$initializePathNodeTypeCache();
+            }
+        }
+
+        if (BlockStateFlagHolder.class.isAssignableFrom(BlockState.class)) {
+            // Initialize / Reinitialize the cached block flags.
+            for (BlockState blockState : Block.BLOCK_STATE_REGISTRY) {
+                ((BlockStateFlagHolder) blockState).lithium$initializeFlags();
+            }
+        }
+    }
+}

common/src/main/java/net/caffeinemc/mods/lithium/mixin/ai/pathing/FuelValuesMixin.java

@@ -3,9 +3,10 @@
                 A faster code path is used for determining what kind of path-finding node type is associated with a
                 given block. Additionally, a faster chunk cache will be used for accessing blocks while evaluating
                 paths.""",
-        depends = @MixinConfigDependency(
-                dependencyPath = "mixin.util.chunk_access"
-        )
+        depends = {
+                @MixinConfigDependency(dependencyPath = "mixin.util.chunk_access"),
+                @MixinConfigDependency(dependencyPath = "mixin.util.initialization")
+        }
 )
 package net.caffeinemc.mods.lithium.mixin.ai.pathing;
 

common/src/main/java/net/caffeinemc/mods/lithium/mixin/ai/pathing/package-info.java

@@ -11,7 +11,7 @@
 @Mixin(value = BlockBehaviour.BlockStateBase.class, priority = 1010)
 public class BlockStateBaseMixin implements BlockStateFlagHolder {
     @Unique
-    private int flags;
+    private int flags = -1;
 
     @Override
     public void lithium$initializeFlags() {
@@ -31,6 +31,10 @@ public class BlockStateBaseMixin implements BlockStateFlagHolder {
 
     @Override
     public int lithium$getAllFlags() {
-        return this.flags;
+        int blockStateFlags = this.flags;
+        if (blockStateFlags == -1) {
+            throw new IllegalStateException("Tried to get uninitialized block state flags!");
+        }
+        return blockStateFlags;
     }
 }

common/src/main/java/net/caffeinemc/mods/lithium/mixin/util/block_tracking/BlockStateBaseMixin.java

@@ -4,7 +4,8 @@
                 " certain blocks being placed or broken.",
         depends = {
                 @MixinConfigDependency(dependencyPath = "mixin.util.data_storage"),
-                @MixinConfigDependency(dependencyPath = "mixin.util.chunk_status_tracking")
+                @MixinConfigDependency(dependencyPath = "mixin.util.chunk_status_tracking"),
+                @MixinConfigDependency(dependencyPath = "mixin.util.initialization")
         }
 )
 package net.caffeinemc.mods.lithium.mixin.util.block_tracking;

common/src/main/java/net/caffeinemc/mods/lithium/mixin/util/block_tracking/FuelValuesMixin.java

@@ -0,0 +1,4 @@
+@MixinConfigOption(description = "Platform dependent initialization hooks.")
+package net.caffeinemc.mods.lithium.mixin.util.initialization;
+
+import net.caffeinemc.gradle.MixinConfigOption;

common/src/main/java/net/caffeinemc/mods/lithium/mixin/util/block_tracking/package-info.java

@@ -9,7 +9,6 @@
   "mixins" : [
     "ai.pathing.BlockStateBaseMixin",
     "ai.pathing.FlyNodeEvaluatorMixin",
-    "ai.pathing.FuelValuesMixin",
     "ai.pathing.PathfindingContextAccessor",
     "ai.pathing.PathfindingContextMixin",
     "ai.pathing.PathNavigationRegionMixin",
@@ -181,7 +180,6 @@
     "util.accessors.ServerLevelAccessor",
     "util.block_entity_retrieval.LevelMixin",
     "util.block_tracking.BlockStateBaseMixin",
-    "util.block_tracking.FuelValuesMixin",
     "util.block_tracking.LevelChunkSectionMixin",
     "util.chunk_access.LevelReaderMixin",
     "util.chunk_access.PathNavigationRegionMixin",

common/src/main/java/net/caffeinemc/mods/lithium/mixin/util/initialization/package-info.java

@@ -0,0 +1,26 @@
+package net.caffeinemc.mods.lithium.fabric.mixin.util.initialization;
+
+import net.caffeinemc.mods.lithium.common.initialization.BlockInfoInitializer;
+import net.minecraft.core.HolderLookup;
+import net.minecraft.world.flag.FeatureFlagSet;
+import net.minecraft.world.level.block.entity.FuelValues;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+
+/**
+ * Hook into the initialization of fuel values, because those are always updated after block tags are modified,
+ * and we must among others, update our cache path node information which is also based on block tags.
+ */
+@Mixin(FuelValues.class)
+public class FuelValuesMixin {
+
+    @Inject(
+            method = "vanillaBurnTimes(Lnet/minecraft/core/HolderLookup$Provider;Lnet/minecraft/world/flag/FeatureFlagSet;I)Lnet/minecraft/world/level/block/entity/FuelValues;",
+            at = @At(value = "RETURN")
+    )
+    private static void initializeBlockInfo(HolderLookup.Provider provider, FeatureFlagSet featureFlagSet, int i, CallbackInfoReturnable<FuelValues> cir) {
+        BlockInfoInitializer.initializeBlockInfo();
+    }
+}

common/src/main/resources/lithium.mixins.json

@@ -1,23 +1,24 @@
 {
-  "package": "net.caffeinemc.mods.lithium.fabric.mixin",
-  "required": true,
-  "compatibilityLevel": "JAVA_21",
-  "plugin": "net.caffeinemc.mods.lithium.mixin.LithiumMixinPlugin",
-  "injectors": {
-    "defaultRequire": 1
+  "package" : "net.caffeinemc.mods.lithium.fabric.mixin",
+  "required" : true,
+  "compatibilityLevel" : "JAVA_21",
+  "plugin" : "net.caffeinemc.mods.lithium.mixin.LithiumMixinPlugin",
+  "injectors" : {
+    "defaultRequire" : 1
   },
-  "overwrites": {
-    "conformVisibility": true
+  "overwrites" : {
+    "conformVisibility" : true
   },
-  "mixins": [
+  "mixins" : [
     "block.hopper.LevelMixin",
     "collections.poi_types.PoiTypesMixin",
     "compat.worldedit.LevelChunkMixin",
     "entity.collisions.fluid.EntityMixin",
     "experimental.entity.block_caching.fluid_pushing.EntityMixin",
+    "util.initialization.FuelValuesMixin",
     "util.inventory_change_listening.BlockEntityMixin",
     "util.inventory_change_listening.ChestBlockEntityMixin"
   ],
-  "client": [
+  "client" : [
   ]
 }

fabric/src/main/java/net/caffeinemc/mods/lithium/fabric/mixin/util/initialization/FuelValuesMixin.java

@@ -26,7 +26,8 @@ A faster code path is used for determining what kind of path-finding node type i
 given block. Additionally, a faster chunk cache will be used for accessing blocks while evaluating
 paths.  
 Requirements:
-- `mixin.util.chunk_access=true`  
+- `mixin.util.chunk_access=true`
+- `mixin.util.initialization=true`  
 
 ### `mixin.ai.poi`
 (default: `true`)  
@@ -511,7 +512,8 @@ Allows access to existing BlockEntities without creating new ones
 Chunk sections count certain blocks inside them and provide a method to quickly check whether a chunk contains any of these blocks. Furthermore, chunk sections can notify registered listeners about certain blocks being placed or broken.  
 Requirements:
 - `mixin.util.data_storage=true`
-- `mixin.util.chunk_status_tracking=true`  
+- `mixin.util.chunk_status_tracking=true`
+- `mixin.util.initialization=true`  
 
 ### `mixin.util.chunk_access`
 (default: `true`)  
@@ -542,6 +544,10 @@ Requirements:
 (default: `true`)  
 Entity sections store their position
 
+### `mixin.util.initialization`
+(default: `true`)  
+Platform dependent initialization hooks.
+  
 ### `mixin.util.inventory_change_listening`
 (default: `true`)  
 Certain BlockEntity Inventories emit updates to their listeners when their stack list is changed or the inventory becomes invalid

fabric/src/main/resources/lithium-fabric.mixins.json

@@ -26,7 +26,8 @@ A faster code path is used for determining what kind of path-finding node type i
 given block. Additionally, a faster chunk cache will be used for accessing blocks while evaluating
 paths.  
 Requirements:
-- `mixin.util.chunk_access=true`  
+- `mixin.util.chunk_access=true`
+- `mixin.util.initialization=true`  
 
 ### `mixin.ai.poi`
 (default: `true`)  
@@ -492,7 +493,8 @@ Allows access to existing BlockEntities without creating new ones
 Chunk sections count certain blocks inside them and provide a method to quickly check whether a chunk contains any of these blocks. Furthermore, chunk sections can notify registered listeners about certain blocks being placed or broken.  
 Requirements:
 - `mixin.util.data_storage=true`
-- `mixin.util.chunk_status_tracking=true`  
+- `mixin.util.chunk_status_tracking=true`
+- `mixin.util.initialization=true`  
 
 ### `mixin.util.chunk_access`
 (default: `true`)  
@@ -523,6 +525,10 @@ Requirements:
 (default: `true`)  
 Entity sections store their position
 
+### `mixin.util.initialization`
+(default: `true`)  
+Platform dependent initialization hooks.
+  
 ### `mixin.util.inventory_change_listening`
 (default: `true`)  
 Certain BlockEntity Inventories emit updates to their listeners when their stack list is changed or the inventory becomes invalid

lithium-fabric-mixin-config.md

@@ -0,0 +1,27 @@
+package net.caffeinemc.mods.lithium.neoforge.mixin.util.initialization;
+
+import net.caffeinemc.mods.lithium.common.initialization.BlockInfoInitializer;
+import net.minecraft.core.RegistryAccess;
+import net.minecraft.world.flag.FeatureFlagSet;
+import net.minecraft.world.level.block.entity.FuelValues;
+import net.neoforged.neoforge.common.DataMapHooks;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+
+/**
+ * Hook into the initialization of fuel values, because those are always updated after block tags are modified,
+ * and we must among others, update our cache path node information which is also based on block tags.
+ */
+@Mixin(DataMapHooks.class)
+public class DataMapHooksMixin {
+
+    @Inject(
+            method = "populateFuelValues",
+            at = @At(value = "RETURN")
+    )
+    private static void initializeCachedBlockData(RegistryAccess lookupProvider, FeatureFlagSet features, CallbackInfoReturnable<FuelValues> cir) {
+        BlockInfoInitializer.initializeBlockInfo();
+    }
+}

lithium-neoforge-mixin-config.md

@@ -12,6 +12,7 @@
   "mixins" : [
     "block.hopper.HopperBlockEntityMixin",
     "block.hopper.LevelMixin",
+    "util.initialization.DataMapHooksMixin",
     "util.inventory_change_listening.ChestBlockEntityMixin"
   ],
   "client" : [