Mark the inside of formed multiblocks as "dangerous" to prevent mobs like pets from teleporting inside #8085

pupnewfster · pupnewfster · commit 9f6de679aeec · 2024-05-31T14:58:58.000-05:00
diff --git a/src/main/java/mekanism/common/block/attribute/Attributes.java b/src/main/java/mekanism/common/block/attribute/Attributes.java
@@ -4,21 +4,18 @@
 import java.util.function.ToIntBiFunction;
 import mekanism.common.block.attribute.Attribute.TileAttribute;
 import mekanism.common.block.states.BlockStateHelper;
-import mekanism.common.lib.multiblock.IInternalMultiblock;
-import mekanism.common.lib.multiblock.IMultiblock;
-import mekanism.common.lib.multiblock.IStructuralMultiblock;
-import mekanism.common.lib.multiblock.MultiblockData;
-import mekanism.common.lib.multiblock.Structure;
 import mekanism.common.tile.base.TileEntityMekanism;
 import mekanism.common.util.WorldUtils;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.world.entity.EntityType;
-import net.minecraft.world.level.LevelReader;
-import net.minecraft.world.level.block.entity.BlockEntity;
+import net.minecraft.world.entity.Mob;
+import net.minecraft.world.level.BlockGetter;
 import net.minecraft.world.level.block.state.BlockBehaviour;
 import net.minecraft.world.level.block.state.BlockBehaviour.Properties;
 import net.minecraft.world.level.block.state.BlockBehaviour.StateArgumentPredicate;
+import net.minecraft.world.level.block.state.BlockState;
+import net.minecraft.world.level.pathfinder.PathType;
 import net.minecraft.world.level.storage.loot.functions.FunctionUserBuilder;
 import net.minecraft.world.level.storage.loot.predicates.ConditionUserBuilder;
 import org.jetbrains.annotations.NotNull;
@@ -100,41 +97,7 @@ public static class AttributeMobSpawn implements Attribute {
         public static final StateArgumentPredicate<EntityType<?>> NEVER_PREDICATE = (state, reader, pos, entityType) -> false;
         public static final AttributeMobSpawn NEVER = new AttributeMobSpawn(NEVER_PREDICATE);
         public static final AttributeMobSpawn WHEN_NOT_FORMED = new AttributeMobSpawn((state, reader, pos, entityType) -> {
-            BlockEntity tile = WorldUtils.getTileEntity(reader, pos);
-            if (tile instanceof IMultiblock<?> multiblockTile) {
-                if (reader instanceof LevelReader levelReader && levelReader.isClientSide()) {
-                    //If we are on the client just check if we are formed as we don't sync structure information
-                    // to the client. This way the client is at least relatively accurate with what values
-                    // it returns for if mobs can spawn
-                    if (multiblockTile.getMultiblock().isFormed()) {
-                        return false;
-                    }
-                } else if (multiblockTile.getMultiblock().isPositionInsideBounds(multiblockTile.getStructure(), pos.above())) {
-                    //If the multiblock is formed and the position above this block is inside the bounds of the multiblock
-                    // don't allow spawning on it.
-                    return false;
-                }
-            } else if (tile instanceof IStructuralMultiblock structuralMultiblock && structuralMultiblock.hasFormedMultiblock()) {
-                //Note: This isn't actually used as all our structural multiblocks are transparent and vanilla tends to not let
-                // mobs spawn on glass or stuff
-                if (reader instanceof LevelReader levelReader && levelReader.isClientSide()) {
-                    //If we are on the client return we can't spawn if it is formed. This way the client is at least relatively
-                    // accurate with what values it returns for if mobs can spawn
-                    return false;
-                } else {
-                    BlockPos above = pos.above();
-                    for (Structure structure : structuralMultiblock.getStructureMap().values()) {
-                        //Manually handle the getMultiblockData logic to avoid extra lookups
-                        MultiblockData data = structure.getMultiblockData();
-                        if (data != null && data.isFormed() && data.isPositionInsideBounds(structure, above)) {
-                            //If the multiblock is formed and the position above this block is inside the bounds of the multiblock
-                            // don't allow spawning on it.
-                            return false;
-                        }
-                    }
-                }
-            } else if (tile instanceof IInternalMultiblock internalMultiblock && internalMultiblock.hasFormedMultiblock()) {
-                //If it is an internal multiblock don't allow spawning mobs on it if it is formed
+            if (WorldUtils.isInsideFormedMultiblock(reader, pos, null)) {
                 return false;
             }
             //Super implementation
@@ -153,6 +116,19 @@ public void adjustProperties(Properties props) {
         }
     }
 
+    @FunctionalInterface
+    public interface PathCheck {
+
+        @Nullable
+        PathType getBlockPathType(@NotNull BlockState state, @NotNull BlockGetter level, @NotNull BlockPos pos, @Nullable Mob mob);
+    }
+
+    public record AttributeCustomPathType(Attributes.PathCheck pathCheck) implements Attribute {
+
+        public static final AttributeCustomPathType WHEN_NOT_FORMED = new AttributeCustomPathType((state, level, pos, mob) ->
+              WorldUtils.isInsideFormedMultiblock(level, pos, mob) ? PathType.DAMAGE_OTHER : null);
+    }
+
     /** If a block can emit redstone. */
     public static class AttributeRedstoneEmitter<TILE extends TileEntityMekanism> implements TileAttribute<TILE> {
 
diff --git a/src/main/java/mekanism/common/block/prefab/BlockBase.java b/src/main/java/mekanism/common/block/prefab/BlockBase.java
@@ -8,6 +8,7 @@
 import mekanism.common.block.attribute.Attribute;
 import mekanism.common.block.attribute.AttributeCustomShape;
 import mekanism.common.block.attribute.AttributeStateFacing;
+import mekanism.common.block.attribute.Attributes.AttributeCustomPathType;
 import mekanism.common.block.attribute.Attributes.AttributeCustomResistance;
 import mekanism.common.block.interfaces.IColoredBlock;
 import mekanism.common.block.interfaces.IHasDescription;
@@ -20,6 +21,7 @@
 import net.minecraft.network.chat.MutableComponent;
 import net.minecraft.world.InteractionHand;
 import net.minecraft.world.ItemInteractionResult;
+import net.minecraft.world.entity.Mob;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.BlockGetter;
@@ -29,10 +31,12 @@
 import net.minecraft.world.level.block.state.BlockState;
 import net.minecraft.world.level.block.state.properties.BlockStateProperties;
 import net.minecraft.world.level.pathfinder.PathComputationType;
+import net.minecraft.world.level.pathfinder.PathType;
 import net.minecraft.world.phys.BlockHitResult;
 import net.minecraft.world.phys.shapes.CollisionContext;
 import net.minecraft.world.phys.shapes.VoxelShape;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public class BlockBase<TYPE extends BlockType> extends BlockMekanism implements IHasDescription, ITypeBlock {
 
@@ -95,6 +99,19 @@ protected boolean isPathfindable(@NotNull BlockState state, @NotNull PathComputa
         return !type.has(AttributeCustomShape.class) && super.isPathfindable(state, pathType);
     }
 
+    @Nullable
+    @Override
+    public PathType getBlockPathType(@NotNull BlockState state, @NotNull BlockGetter level, @NotNull BlockPos pos, @Nullable Mob mob) {
+        AttributeCustomPathType customPathType = type.get(AttributeCustomPathType.class);
+        if (customPathType != null) {
+            PathType pathType = customPathType.pathCheck().getBlockPathType(state, level, pos, mob);
+            if (pathType != null) {
+                return pathType;
+            }
+        }
+        return super.getBlockPathType(state, level, pos, mob);
+    }
+
     @NotNull
     @Override
     protected VoxelShape getShape(@NotNull BlockState state, @NotNull BlockGetter world, @NotNull BlockPos pos, @NotNull CollisionContext context) {
diff --git a/src/main/java/mekanism/common/content/blocktype/BlockType.java b/src/main/java/mekanism/common/content/blocktype/BlockType.java
@@ -12,6 +12,7 @@
 import mekanism.common.block.attribute.AttributeMultiblock;
 import mekanism.common.block.attribute.AttributeSideConfig;
 import mekanism.common.block.attribute.Attributes.AttributeComputerIntegration;
+import mekanism.common.block.attribute.Attributes.AttributeCustomPathType;
 import mekanism.common.block.attribute.Attributes.AttributeLight;
 import mekanism.common.block.attribute.Attributes.AttributeMobSpawn;
 import mekanism.common.block.interfaces.ITypeBlock;
@@ -145,11 +146,11 @@ public T withComputerSupport(ITier tier, String name) {
         }
 
         public final T externalMultiblock() {
-            return with(AttributeMultiblock.EXTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED);
+            return with(AttributeMultiblock.EXTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED, AttributeCustomPathType.WHEN_NOT_FORMED);
         }
 
         public final T internalMultiblock() {
-            return with(AttributeMultiblock.INTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED);
+            return with(AttributeMultiblock.INTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED, AttributeCustomPathType.WHEN_NOT_FORMED);
         }
 
         public BLOCK build() {
diff --git a/src/main/java/mekanism/common/util/WorldUtils.java b/src/main/java/mekanism/common/util/WorldUtils.java
@@ -4,6 +4,11 @@
 import java.util.Collection;
 import java.util.Optional;
 import mekanism.common.Mekanism;
+import mekanism.common.lib.multiblock.IInternalMultiblock;
+import mekanism.common.lib.multiblock.IMultiblock;
+import mekanism.common.lib.multiblock.IStructuralMultiblock;
+import mekanism.common.lib.multiblock.MultiblockData;
+import mekanism.common.lib.multiblock.Structure;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.BlockPos.MutableBlockPos;
 import net.minecraft.core.Direction;
@@ -15,6 +20,7 @@
 import net.minecraft.sounds.SoundSource;
 import net.minecraft.util.Mth;
 import net.minecraft.world.entity.Entity;
+import net.minecraft.world.entity.Mob;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.context.BlockPlaceContext;
@@ -445,6 +451,44 @@ public static Direction sideDifference(BlockPos pos, BlockPos other) {
         return null;
     }
 
+    //TODO: Come up with a better method name, this is used for checking if a mob can spawn inside or if it is dangerous for mobs to say teleport inside of
+    public static boolean isInsideFormedMultiblock(BlockGetter reader, BlockPos pos, @Nullable Mob mob) {
+        BlockEntity tile = WorldUtils.getTileEntity(reader, pos);
+        if (tile instanceof IMultiblock<?> multiblockTile) {
+            if (reader instanceof LevelReader levelReader && levelReader.isClientSide() || mob != null && mob.level().isClientSide()) {
+                //If we are on the client just check if we are formed as we don't sync structure information
+                // to the client. This way the client is at least relatively accurate with what values
+                // it returns for if mobs can spawn
+                return multiblockTile.getMultiblock().isFormed();
+            }
+            //If the multiblock is formed and the position above this block is inside the bounds of the multiblock
+            // don't allow spawning on it.
+            return multiblockTile.getMultiblock().isPositionInsideBounds(multiblockTile.getStructure(), pos.above());
+        } else if (tile instanceof IStructuralMultiblock structuralMultiblock && structuralMultiblock.hasFormedMultiblock()) {
+            //Note: This isn't actually used as all our structural multiblocks are transparent and vanilla tends to not let
+            // mobs spawn on glass or stuff
+            if (reader instanceof LevelReader levelReader && levelReader.isClientSide() || mob != null && mob.level().isClientSide()) {
+                //If we are on the client return we can't spawn if it is formed. This way the client is at least relatively
+                // accurate with what values it returns for if mobs can spawn
+                return true;
+            } else {
+                BlockPos above = pos.above();
+                for (Structure structure : structuralMultiblock.getStructureMap().values()) {
+                    //Manually handle the getMultiblockData logic to avoid extra lookups
+                    MultiblockData data = structure.getMultiblockData();
+                    if (data != null && data.isFormed() && data.isPositionInsideBounds(structure, above)) {
+                        //If the multiblock is formed and the position above this block is inside the bounds of the multiblock
+                        // don't allow spawning on it.
+                        return true;
+                    }
+                }
+            }
+            return false;
+        }
+        //If it is an internal multiblock don't allow spawning mobs on it if it is formed
+        return tile instanceof IInternalMultiblock internalMultiblock && internalMultiblock.hasFormedMultiblock();
+    }
+
     /**
      * Whether the provided chunk is being vibrated by a Seismic Vibrator.
      *

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`import mekanism.common.block.attribute.AttributeMultiblock;`
`13`	`13`	`import mekanism.common.block.attribute.AttributeSideConfig;`
`14`	`14`	`import mekanism.common.block.attribute.Attributes.AttributeComputerIntegration;`
	`15`	`+import mekanism.common.block.attribute.Attributes.AttributeCustomPathType;`
`15`	`16`	`import mekanism.common.block.attribute.Attributes.AttributeLight;`
`16`	`17`	`import mekanism.common.block.attribute.Attributes.AttributeMobSpawn;`
`17`	`18`	`import mekanism.common.block.interfaces.ITypeBlock;`
`@@ -145,11 +146,11 @@ public T withComputerSupport(ITier tier, String name) {`
`145`	`146`	`}`
`146`	`147`
`147`	`148`	`public final T externalMultiblock() {`
`148`		`- return with(AttributeMultiblock.EXTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED);`
	`149`	`+ return with(AttributeMultiblock.EXTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED, AttributeCustomPathType.WHEN_NOT_FORMED);`
`149`	`150`	`}`
`150`	`151`
`151`	`152`	`public final T internalMultiblock() {`
`152`		`- return with(AttributeMultiblock.INTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED);`
	`153`	`+ return with(AttributeMultiblock.INTERNAL, AttributeMobSpawn.WHEN_NOT_FORMED, AttributeCustomPathType.WHEN_NOT_FORMED);`
`153`	`154`	`}`
`154`	`155`
`155`	`156`	`public BLOCK build() {`