Spawn Proofer/Light Overlay improvements (#5485)

- Added optional raycasting for stricter servers.
- Added blocks per tick option so Spawn Proofer can place faster on servers where allowed.
- Added adjustable light levels, this allows for players to be able to place blocks wherever regardless of light level (useful for the nether).
- Added adjustable light levels to the light overlay. This will help a lot when players are trying to spawn proof odd mobs that don't spawn in typical light levels.
- Fixed Spawn Proofer not placing on soul sand and snow. Light overlay also renders those blocks now.

Author: Gingerbeard5773

src/main/java/meteordevelopment/meteorclient/systems/modules/render/LightOverlay.java

@@ -51,10 +51,12 @@ public class LightOverlay extends Module {
         .build()
     );
 
-    private final Setting<Boolean> newMobSpawnLightLevel = sgGeneral.add(new BoolSetting.Builder()
-        .name("new-mob-spawn-light-level")
-        .description("Use the new (1.18+) mob spawn behavior")
-        .defaultValue(true)
+    private final Setting<Integer> lightLevel = sgGeneral.add(new IntSetting.Builder()
+        .name("light-level")
+        .description("Which light levels to render. Old spawning light: 7.")
+        .defaultValue(0)
+        .min(0)
+        .sliderMax(15)
         .build()
     );
 
@@ -86,9 +88,8 @@ private void onTick(TickEvent.Pre event) {
         for (Cross cross : crosses) crossPool.free(cross);
         crosses.clear();
 
-        int spawnLightLevel = newMobSpawnLightLevel.get() ? 0 : 7;
         BlockIterator.register(horizontalRange.get(), verticalRange.get(), (blockPos, blockState) -> {
-            switch (BlockUtils.isValidMobSpawn(blockPos, blockState, spawnLightLevel)) {
+            switch (BlockUtils.isValidMobSpawn(blockPos, blockState, lightLevel.get())) {
                 case Potential -> crosses.add(crossPool.get().set(blockPos, true));
                 case Always -> crosses.add((crossPool.get().set(blockPos, false)));
             }

src/main/java/meteordevelopment/meteorclient/systems/modules/world/SpawnProofer.java

@@ -12,46 +12,71 @@
 import meteordevelopment.meteorclient.utils.misc.Pool;
 import meteordevelopment.meteorclient.utils.player.FindItemResult;
 import meteordevelopment.meteorclient.utils.player.InvUtils;
+import meteordevelopment.meteorclient.utils.player.PlayerUtils;
 import meteordevelopment.meteorclient.utils.world.BlockIterator;
 import meteordevelopment.meteorclient.utils.world.BlockUtils;
 import meteordevelopment.orbit.EventHandler;
 import net.minecraft.block.*;
 import net.minecraft.util.math.BlockPos;
+import net.minecraft.util.math.Vec3d;
+import net.minecraft.util.hit.BlockHitResult;
+import net.minecraft.world.RaycastContext;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Comparator;
 
 public class SpawnProofer extends Module {
     private final SettingGroup sgGeneral = settings.getDefaultGroup();
 
-    private final Setting<Integer> range = sgGeneral.add(new IntSetting.Builder()
-        .name("range")
-        .description("Range for block placement and rendering")
-        .defaultValue(3)
+    private final Setting<Integer> placeDelay = sgGeneral.add(new IntSetting.Builder()
+        .name("place-delay")
+        .description("The tick delay between placing blocks.")
+        .defaultValue(1)
+        .range(0, 10)
+        .build()
+    );
+
+    private final Setting<Double> placeRange = sgGeneral.add(new DoubleSetting.Builder()
+        .name("place-range")
+        .description("How far away from the player you can place a block.")
+        .defaultValue(4.5)
         .min(0)
+        .sliderMax(6)
         .build()
     );
 
-    private final Setting<List<Block>> blocks = sgGeneral.add(new BlockListSetting.Builder()
-        .name("blocks")
-        .description("Block to use for spawn proofing")
-        .defaultValue(Blocks.TORCH, Blocks.STONE_BUTTON, Blocks.STONE_SLAB)
-        .filter(this::filterBlocks)
+    private final Setting<Double> wallsRange = sgGeneral.add(new DoubleSetting.Builder()
+        .name("walls-range")
+        .description("How far away from the player you can place a block behind walls.")
+        .defaultValue(4.5)
+        .min(0)
+        .sliderMax(6)
         .build()
     );
 
-    private final Setting<Integer> delay = sgGeneral.add(new IntSetting.Builder()
-        .name("delay")
-        .description("Delay in ticks between placing blocks")
+    private final Setting<Integer> blocksPerTick = sgGeneral.add(new IntSetting.Builder()
+        .name("blocks-per-tick")
+        .description("How many blocks to place in one tick.")
+        .defaultValue(1)
+        .min(1)
+        .build()
+    );
+
+    private final Setting<Integer> lightLevel = sgGeneral.add(new IntSetting.Builder()
+        .name("light-level")
+        .description("Light levels to spawn proof. Old spawning light: 7.")
         .defaultValue(0)
         .min(0)
+        .sliderMax(15)
         .build()
     );
 
-    private final Setting<Boolean> rotate = sgGeneral.add(new BoolSetting.Builder()
-        .name("rotate")
-        .description("Rotates towards the blocks being placed.")
-        .defaultValue(true)
+    private final Setting<List<Block>> blocks = sgGeneral.add(new BlockListSetting.Builder()
+        .name("blocks")
+        .description("Block to use for spawn proofing.")
+        .defaultValue(Blocks.TORCH, Blocks.STONE_BUTTON, Blocks.STONE_SLAB)
+        .filter(this::filterBlocks)
         .build()
     );
 
@@ -62,33 +87,29 @@ public class SpawnProofer extends Module {
         .build()
     );
 
-    private final Setting<Boolean> newMobSpawnLightLevel = sgGeneral.add(new BoolSetting.Builder()
-        .name("new-mob-spawn-light-level")
-        .description("Use the new (1.18+) mob spawn behavior")
+    private final Setting<Boolean> rotate = sgGeneral.add(new BoolSetting.Builder()
+        .name("rotate")
+        .description("Rotates towards the blocks being placed.")
         .defaultValue(true)
         .build()
     );
 
-
     private final Pool<BlockPos.Mutable> spawnPool = new Pool<>(BlockPos.Mutable::new);
     private final List<BlockPos.Mutable> spawns = new ArrayList<>();
-    private int ticksWaited;
+    private int timer;
 
     public SpawnProofer() {
         super(Categories.World, "spawn-proofer", "Automatically spawnproofs unlit areas.");
     }
 
     @EventHandler
     private void onTickPre(TickEvent.Pre event) {
-        // Delay
-        if (delay.get() != 0 && ticksWaited < delay.get() - 1) {
-            return;
-        }
+        if (timer < placeDelay.get()) return;
 
         // Find slot
         boolean foundBlock = InvUtils.testInHotbar(itemStack -> blocks.get().contains(Block.getBlockFromItem(itemStack.getItem())));
         if (!foundBlock) {
-            error("Found none of the chosen blocks in hotbar");
+            error("Found none of the chosen blocks in hotbar.");
             toggle();
             return;
         }
@@ -97,13 +118,17 @@ private void onTickPre(TickEvent.Pre event) {
         for (BlockPos.Mutable blockPos : spawns) spawnPool.free(blockPos);
         spawns.clear();
 
-        int lightLevel = newMobSpawnLightLevel.get() ? 0 : 7;
-        BlockIterator.register(range.get(), range.get(), (blockPos, blockState) -> {
-            BlockUtils.MobSpawn spawn = BlockUtils.isValidMobSpawn(blockPos, blockState, lightLevel);
+        BlockIterator.register((int) Math.ceil(placeRange.get()), (int) Math.ceil(placeRange.get()), (blockPos, blockState) -> {
+            BlockUtils.MobSpawn spawn = BlockUtils.isValidMobSpawn(blockPos, blockState, lightLevel.get());
 
             if ((spawn == BlockUtils.MobSpawn.Always && (mode.get() == Mode.Always || mode.get() == Mode.Both)) ||
                     spawn == BlockUtils.MobSpawn.Potential && (mode.get() == Mode.Potential || mode.get() == Mode.Both)) {
 
+                if (!BlockUtils.canPlace(blockPos)) return;
+
+                // Check range and raycast
+                if (isOutOfRange(blockPos)) return;
+
                 spawns.add(spawnPool.get().set(blockPos));
             }
         });
@@ -112,49 +137,48 @@ private void onTickPre(TickEvent.Pre event) {
     @EventHandler
     private void onTickPost(TickEvent.Post event) {
         // Delay
-        if (delay.get() != 0 && ticksWaited < delay.get() - 1) {
-            ticksWaited++;
-            return;
-        }
+        if (timer++ < placeDelay.get()) return;
 
         if (spawns.isEmpty()) return;
 
         // Find slot
         FindItemResult block = InvUtils.findInHotbar(itemStack -> blocks.get().contains(Block.getBlockFromItem(itemStack.getItem())));
         if (!block.found()) {
-            error("Found none of the chosen blocks in hotbar");
+            error("Found none of the chosen blocks in hotbar.");
             toggle();
             return;
         }
 
-        // Place blocks
-        if (delay.get() == 0) {
-            for (BlockPos blockPos : spawns) BlockUtils.place(blockPos, block, rotate.get(), -50, false);
+        int placedCount = 0;
+
+        // Sort blocks to use the lowest light level spawns first
+        if (isLightSource(Block.getBlockFromItem(mc.player.getInventory().getStack(block.slot()).getItem()))) {
+            spawns.sort(Comparator.comparingInt(blockPos -> mc.world.getLightLevel(blockPos)));
+            placedCount = blocksPerTick.get() - 1; // Force only one light source per tick to stop unnecessary placements
         }
-        else {
-            // Check if light source
-            if (isLightSource(Block.getBlockFromItem(mc.player.getInventory().getStack(block.slot()).getItem()))) {
-
-                // Find lowest light level
-                int lowestLightLevel = 16;
-                BlockPos.Mutable selectedBlockPos = spawns.getFirst();
-
-                for (BlockPos blockPos : spawns) {
-                    int lightLevel = mc.world.getLightLevel(blockPos);
-                    if (lightLevel < lowestLightLevel) {
-                        lowestLightLevel = lightLevel;
-                        selectedBlockPos.set(blockPos);
-                    }
-                }
-
-                BlockUtils.place(selectedBlockPos, block, rotate.get(), -50, false);
-            }
-            else {
-                BlockUtils.place(spawns.getFirst(), block, rotate.get(), -50, false);
+
+        // Place blocks!
+        for (BlockPos blockPos : spawns) {
+            if (placedCount >= blocksPerTick.get()) continue;
+
+            if (BlockUtils.place(blockPos, block, rotate.get(), -50, false)) {
+                placedCount++;
             }
         }
 
-        ticksWaited = 0;
+        timer = 0;
+    }
+
+    private boolean isOutOfRange(BlockPos blockPos) {
+        Vec3d pos = blockPos.toCenterPos();
+        if (!PlayerUtils.isWithin(pos, placeRange.get())) return true;
+
+        RaycastContext raycastContext = new RaycastContext(mc.player.getEyePos(), pos, RaycastContext.ShapeType.COLLIDER, RaycastContext.FluidHandling.NONE, mc.player);
+        BlockHitResult result = mc.world.raycast(raycastContext);
+        if (result == null || !result.getBlockPos().equals(blockPos))
+            return !PlayerUtils.isWithin(pos, wallsRange.get());
+
+        return false;
     }
 
     private boolean filterBlocks(Block block) {
@@ -180,7 +204,6 @@ private boolean isLightSource(Block block) {
     public enum Mode {
         Always,
         Potential,
-        Both,
-        None
+        Both
     }
 }

src/main/java/meteordevelopment/meteorclient/utils/world/BlockUtils.java

@@ -306,32 +306,32 @@ public static boolean isClickable(Block block) {
             || block instanceof TrapdoorBlock;
     }
 
-    public static MobSpawn isValidMobSpawn(BlockPos blockPos, boolean newMobSpawnLightLevel) {
-        return isValidMobSpawn(blockPos, mc.world.getBlockState(blockPos), newMobSpawnLightLevel ? 0 : 7);
-    }
 
     public static MobSpawn isValidMobSpawn(BlockPos blockPos, BlockState blockState, int spawnLightLimit) {
-        if (!(blockState.getBlock() instanceof AirBlock)) return MobSpawn.Never;
-
-        BlockPos down = blockPos.down();
-        BlockState downState = mc.world.getBlockState(down);
-        if (downState.getBlock() == Blocks.BEDROCK) return MobSpawn.Never;
+        boolean snow = blockState.getBlock() instanceof SnowBlock && blockState.get(SnowBlock.LAYERS) == 1;
+        if (!blockState.isAir() && !snow) return MobSpawn.Never;
 
-        if (!topSurface(downState)) {
-            if (downState.getCollisionShape(mc.world, down) != VoxelShapes.fullCube())
-                return MobSpawn.Never;
-            if (downState.isTransparent()) return MobSpawn.Never;
-        }
+        if (!isValidSpawnBlock(mc.world.getBlockState(blockPos.down()))) return MobSpawn.Never;
 
         if (mc.world.getLightLevel(LightType.BLOCK, blockPos) > spawnLightLimit) return MobSpawn.Never;
         else if (mc.world.getLightLevel(LightType.SKY, blockPos) > spawnLightLimit) return  MobSpawn.Potential;
 
         return MobSpawn.Always;
     }
 
-    public static boolean topSurface(BlockState blockState) {
-        if (blockState.getBlock() instanceof SlabBlock && blockState.get(SlabBlock.TYPE) == SlabType.TOP) return true;
-        else return blockState.getBlock() instanceof StairsBlock && blockState.get(StairsBlock.HALF) == BlockHalf.TOP;
+    public static boolean isValidSpawnBlock(BlockState blockState) {
+        Block block = blockState.getBlock();
+
+        if (block == Blocks.BEDROCK
+            || block == Blocks.BARRIER
+            || block instanceof TransparentBlock
+            || block instanceof ScaffoldingBlock) return false;
+
+        if (block == Blocks.SOUL_SAND || block == Blocks.MUD) return true;
+        if (block instanceof SlabBlock && blockState.get(SlabBlock.TYPE) == SlabType.TOP) return true;
+        if (block instanceof StairsBlock && blockState.get(StairsBlock.HALF) == BlockHalf.TOP) return true;
+
+        return blockState.isOpaqueFullCube();
     }
 
     // Finds the best block direction to get when interacting with the block.