From 1b96c646200957e0ef3c96fa890a5df7fac2e881 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Mon, 21 Aug 2023 00:44:47 -0700 Subject: [PATCH] Improve cancelling PreCreatureSpawnEvent with per player mob spawns (#9400) --- .../server/0171-PreCreatureSpawnEvent.patch | 41 +++++++-- ...ement-optional-per-player-mob-spawns.patch | 12 +-- .../0705-Optimise-nearby-player-lookups.patch | 4 +- ...ng-PreCreatureSpawnEvent-with-per-pl.patch | 91 +++++++++++++++++++ ...lace-methods-with-old-StructureType.patch} | 0 ...e-namespaced-commands-if-send-names.patch} | 0 ...-handle-BlockBreakEvent-isDropItems.patch} | 0 ...entity-death-event-for-ender-dragon.patch} | 0 8 files changed, 131 insertions(+), 17 deletions(-) create mode 100644 patches/server/1008-Improve-cancelling-PreCreatureSpawnEvent-with-per-pl.patch rename patches/server/{1008-Deprecate-and-replace-methods-with-old-StructureType.patch => 1009-Deprecate-and-replace-methods-with-old-StructureType.patch} (100%) rename patches/server/{1009-Don-t-tab-complete-namespaced-commands-if-send-names.patch => 1010-Don-t-tab-complete-namespaced-commands-if-send-names.patch} (100%) rename patches/server/{1010-Properly-handle-BlockBreakEvent-isDropItems.patch => 1011-Properly-handle-BlockBreakEvent-isDropItems.patch} (100%) rename patches/server/{1011-Fire-entity-death-event-for-ender-dragon.patch => 1012-Fire-entity-death-event-for-ender-dragon.patch} (100%) diff --git a/patches/server/0171-PreCreatureSpawnEvent.patch b/patches/server/0171-PreCreatureSpawnEvent.patch index 4da8e04bb8..6088886f36 100644 --- a/patches/server/0171-PreCreatureSpawnEvent.patch +++ b/patches/server/0171-PreCreatureSpawnEvent.patch @@ -129,7 +129,7 @@ index 20c39481bcf05e0d43c97b7e841ec9f5f6a0d45d..fc7719d12b5f6011aec2e41a36b4bacd Entity entity = EntityType.loadEntityRecursive(nbttagcompound, world, (entity1) -> { entity1.moveTo(d0, d1, d2, entity1.getYRot(), entity1.getXRot()); diff --git a/src/main/java/net/minecraft/world/level/NaturalSpawner.java b/src/main/java/net/minecraft/world/level/NaturalSpawner.java -index b2bb9bbd3af414c50ec3f8e3e171a679e95ef75e..5338e0e1a67925da0c386735a545bb31096afbb1 100644 +index b2bb9bbd3af414c50ec3f8e3e171a679e95ef75e..6ac513d3044fab1cb1ca0b0c7e85ff871d49d572 100644 --- a/src/main/java/net/minecraft/world/level/NaturalSpawner.java +++ b/src/main/java/net/minecraft/world/level/NaturalSpawner.java @@ -213,7 +213,13 @@ public final class NaturalSpawner { @@ -138,21 +138,29 @@ index b2bb9bbd3af414c50ec3f8e3e171a679e95ef75e..5338e0e1a67925da0c386735a545bb31 - if (NaturalSpawner.isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2) && checker.test(biomesettingsmobs_c.type, blockposition_mutableblockposition, chunk)) { + // Paper start -+ Boolean doSpawning = isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2); -+ if (doSpawning == null) { ++ PreSpawnStatus doSpawning = isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2); ++ if (doSpawning == PreSpawnStatus.ABORT) { + return; + } -+ if (doSpawning && checker.test(biomesettingsmobs_c.type, blockposition_mutableblockposition, chunk)) { ++ if (doSpawning == PreSpawnStatus.SUCCESS && checker.test(biomesettingsmobs_c.type, blockposition_mutableblockposition, chunk)) { + // Paper end Mob entityinsentient = NaturalSpawner.getMobForSpawn(world, biomesettingsmobs_c.type); if (entityinsentient == null) { -@@ -261,9 +267,25 @@ public final class NaturalSpawner { +@@ -261,19 +267,44 @@ public final class NaturalSpawner { return squaredDistance <= 576.0D ? false : (world.getSharedSpawnPos().closerToCenterThan(new Vec3((double) pos.getX() + 0.5D, (double) pos.getY(), (double) pos.getZ() + 0.5D), 24.0D) ? false : Objects.equals(new ChunkPos(pos), chunk.getPos()) || world.isNaturalSpawningAllowed((BlockPos) pos)); } - private static boolean isValidSpawnPostitionForType(ServerLevel world, MobCategory group, StructureManager structureAccessor, ChunkGenerator chunkGenerator, MobSpawnSettings.SpawnerData spawnEntry, BlockPos.MutableBlockPos pos, double squaredDistance) { -+ private static Boolean isValidSpawnPostitionForType(ServerLevel world, MobCategory group, StructureManager structureAccessor, ChunkGenerator chunkGenerator, MobSpawnSettings.SpawnerData spawnEntry, BlockPos.MutableBlockPos pos, double squaredDistance) { // Paper ++ // Paper start ++ private enum PreSpawnStatus { ++ FAIL, ++ SUCCESS, ++ CANCELLED, ++ ABORT ++ } ++ private static PreSpawnStatus isValidSpawnPostitionForType(ServerLevel world, MobCategory group, StructureManager structureAccessor, ChunkGenerator chunkGenerator, MobSpawnSettings.SpawnerData spawnEntry, BlockPos.MutableBlockPos pos, double squaredDistance) { ++ // Paper end EntityType entitytypes = spawnEntry.type; + // Paper start @@ -165,12 +173,27 @@ index b2bb9bbd3af414c50ec3f8e3e171a679e95ef75e..5338e0e1a67925da0c386735a545bb31 + ); + if (!event.callEvent()) { + if (event.shouldAbortSpawn()) { -+ return null; ++ return PreSpawnStatus.ABORT; // Paper + } -+ return false; ++ return PreSpawnStatus.CANCELLED; // Paper + } + } + // Paper end if (entitytypes.getCategory() == MobCategory.MISC) { - return false; +- return false; ++ return PreSpawnStatus.FAIL; // Paper } else if (!entitytypes.canSpawnFarFromPlayer() && squaredDistance > (double) (entitytypes.getCategory().getDespawnDistance() * entitytypes.getCategory().getDespawnDistance())) { +- return false; ++ return PreSpawnStatus.FAIL; // Paper + } else if (entitytypes.canSummon() && NaturalSpawner.canSpawnMobAt(world, structureAccessor, chunkGenerator, group, spawnEntry, pos)) { + SpawnPlacements.Type entitypositiontypes_surface = SpawnPlacements.getPlacementType(entitytypes); + +- return !NaturalSpawner.isSpawnPositionOk(entitypositiontypes_surface, world, pos, entitytypes) ? false : (!SpawnPlacements.checkSpawnRules(entitytypes, world, MobSpawnType.NATURAL, pos, world.random) ? false : world.noCollision(entitytypes.getAABB((double) pos.getX() + 0.5D, (double) pos.getY(), (double) pos.getZ() + 0.5D))); ++ boolean isValid = !NaturalSpawner.isSpawnPositionOk(entitypositiontypes_surface, world, pos, entitytypes) ? false : (!SpawnPlacements.checkSpawnRules(entitytypes, world, MobSpawnType.NATURAL, pos, world.random) ? false : world.noCollision(entitytypes.getAABB((double) pos.getX() + 0.5D, (double) pos.getY(), (double) pos.getZ() + 0.5D))); // Paper ++ return isValid ? PreSpawnStatus.SUCCESS : PreSpawnStatus.FAIL; // Paper + } else { +- return false; ++ return PreSpawnStatus.FAIL; // Paper + } + } + diff --git a/patches/server/0341-implement-optional-per-player-mob-spawns.patch b/patches/server/0341-implement-optional-per-player-mob-spawns.patch index b287591270..629ec01111 100644 --- a/patches/server/0341-implement-optional-per-player-mob-spawns.patch +++ b/patches/server/0341-implement-optional-per-player-mob-spawns.patch @@ -386,7 +386,7 @@ index 5ea537b98fc038798ada3d60570aaf908571d6b9..9e4e2a23891031589a03a5e8dc3e6709 // Yes, this doesn't match Vanilla, but it's the best we can do for now. diff --git a/src/main/java/net/minecraft/world/level/NaturalSpawner.java b/src/main/java/net/minecraft/world/level/NaturalSpawner.java -index f22e1d76586980edb2dc962b4d55ad7a542b61a7..a3461824fd2162d509facf6f64c5008e3f0fd42b 100644 +index 23d53f3fd524cc4d827dc95ab95367702a110a05..e57bb23ec14263b7c9dd721fefbe912963b863d0 100644 --- a/src/main/java/net/minecraft/world/level/NaturalSpawner.java +++ b/src/main/java/net/minecraft/world/level/NaturalSpawner.java @@ -70,6 +70,12 @@ public final class NaturalSpawner { @@ -504,12 +504,12 @@ index f22e1d76586980edb2dc962b4d55ad7a542b61a7..a3461824fd2162d509facf6f64c5008e while (k < 3) { @@ -223,14 +270,14 @@ public final class NaturalSpawner { // Paper start - Boolean doSpawning = isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2); - if (doSpawning == null) { + PreSpawnStatus doSpawning = isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2); + if (doSpawning == PreSpawnStatus.ABORT) { - return; + return j; // Paper } - if (doSpawning && checker.test(biomesettingsmobs_c.type, blockposition_mutableblockposition, chunk)) { + if (doSpawning == PreSpawnStatus.SUCCESS && checker.test(biomesettingsmobs_c.type, blockposition_mutableblockposition, chunk)) { // Paper end Mob entityinsentient = NaturalSpawner.getMobForSpawn(world, biomesettingsmobs_c.type); @@ -545,7 +545,7 @@ index f22e1d76586980edb2dc962b4d55ad7a542b61a7..a3461824fd2162d509facf6f64c5008e } private static boolean isRightDistanceToPlayerAndSpawnPoint(ServerLevel world, ChunkAccess chunk, BlockPos.MutableBlockPos pos, double squaredDistance) { -@@ -558,7 +611,7 @@ public final class NaturalSpawner { +@@ -567,7 +620,7 @@ public final class NaturalSpawner { MobCategory enumcreaturetype = entitytypes.getCategory(); this.mobCategoryCounts.addTo(enumcreaturetype, 1); @@ -554,7 +554,7 @@ index f22e1d76586980edb2dc962b4d55ad7a542b61a7..a3461824fd2162d509facf6f64c5008e } public int getSpawnableChunkCount() { -@@ -574,6 +627,7 @@ public final class NaturalSpawner { +@@ -583,6 +636,7 @@ public final class NaturalSpawner { int i = limit * this.spawnableChunkCount / NaturalSpawner.MAGIC_NUMBER; // CraftBukkit end diff --git a/patches/server/0705-Optimise-nearby-player-lookups.patch b/patches/server/0705-Optimise-nearby-player-lookups.patch index 43c9989b3d..2e5e702005 100644 --- a/patches/server/0705-Optimise-nearby-player-lookups.patch +++ b/patches/server/0705-Optimise-nearby-player-lookups.patch @@ -300,7 +300,7 @@ index 69886eb8bf9769aa8f2942ad68aeadbb4e86c223..5778dd4bdcf116d7932cebcd261c5f62 public abstract ResourceKey getTypeKey(); diff --git a/src/main/java/net/minecraft/world/level/NaturalSpawner.java b/src/main/java/net/minecraft/world/level/NaturalSpawner.java -index d4f99f4592a86e2d8344bc2c44711fef1543acdf..089dd93d4cd4c1f72e63c4944b3b82c1e2ba732d 100644 +index f8ad4601139711ac0491505eee32d4f98b6ceb30..7ee4ae3a31b1aa02140f1075a35ed1cc8d87fe96 100644 --- a/src/main/java/net/minecraft/world/level/NaturalSpawner.java +++ b/src/main/java/net/minecraft/world/level/NaturalSpawner.java @@ -260,7 +260,7 @@ public final class NaturalSpawner { @@ -320,7 +320,7 @@ index d4f99f4592a86e2d8344bc2c44711fef1543acdf..089dd93d4cd4c1f72e63c4944b3b82c1 + return squaredDistance <= 576.0D ? false : (world.getSharedSpawnPos().closerToCenterThan(new Vec3((double) pos.getX() + 0.5D, (double) pos.getY(), (double) pos.getZ() + 0.5D), 24.0D) ? false : Objects.equals(new ChunkPos(pos), chunk.getPos()) || world.isNaturalSpawningAllowed((BlockPos) pos)); // Paper - diff on change, copy into caller } - private static Boolean isValidSpawnPostitionForType(ServerLevel world, MobCategory group, StructureManager structureAccessor, ChunkGenerator chunkGenerator, MobSpawnSettings.SpawnerData spawnEntry, BlockPos.MutableBlockPos pos, double squaredDistance) { // Paper + // Paper start diff --git a/src/main/java/net/minecraft/world/level/chunk/LevelChunk.java b/src/main/java/net/minecraft/world/level/chunk/LevelChunk.java index 4d052f4cde791100f04b822899f0f436feaa23ea..4ff0d2fc9fd76e92e64abd69f2c9e299aa08ac32 100644 --- a/src/main/java/net/minecraft/world/level/chunk/LevelChunk.java diff --git a/patches/server/1008-Improve-cancelling-PreCreatureSpawnEvent-with-per-pl.patch b/patches/server/1008-Improve-cancelling-PreCreatureSpawnEvent-with-per-pl.patch new file mode 100644 index 0000000000..2101d1fec9 --- /dev/null +++ b/patches/server/1008-Improve-cancelling-PreCreatureSpawnEvent-with-per-pl.patch @@ -0,0 +1,91 @@ +From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 +From: kickash32 +Date: Mon, 5 Apr 2021 01:42:35 -0400 +Subject: [PATCH] Improve cancelling PreCreatureSpawnEvent with per player mob + spawns + + +diff --git a/src/main/java/net/minecraft/server/level/ChunkMap.java b/src/main/java/net/minecraft/server/level/ChunkMap.java +index a98c134ce2ea51ae6d6f92959e57a4f0e03b0f6c..a4bf4ed615653ce30d2416a62e680d74e87b53fa 100644 +--- a/src/main/java/net/minecraft/server/level/ChunkMap.java ++++ b/src/main/java/net/minecraft/server/level/ChunkMap.java +@@ -476,8 +476,27 @@ public class ChunkMap extends ChunkStorage implements ChunkHolder.PlayerProvider + } + } + ++ // Paper start - per player mob count backoff ++ public void updateFailurePlayerMobTypeMap(int chunkX, int chunkZ, net.minecraft.world.entity.MobCategory mobCategory) { ++ if (!this.level.paperConfig().entities.spawning.perPlayerMobSpawns) { ++ return; ++ } ++ int idx = mobCategory.ordinal(); ++ final com.destroystokyo.paper.util.misc.PooledLinkedHashSets.PooledObjectLinkedOpenHashSet inRange = this.playerMobDistanceMap.getObjectsInRange(chunkX, chunkZ); ++ if (inRange != null) { ++ final Object[] set = inRange.getBackingSet(); ++ for (int i = 0; i < set.length; i++) { ++ if (!(set[i] instanceof ServerPlayer serverPlayer)) { ++ continue; ++ } ++ ++serverPlayer.mobBackoffCounts[idx]; ++ } ++ } ++ } ++ // Paper end - per player mob count backoff ++ + public int getMobCountNear(ServerPlayer entityPlayer, net.minecraft.world.entity.MobCategory mobCategory) { +- return entityPlayer.mobCounts[mobCategory.ordinal()]; ++ return entityPlayer.mobCounts[mobCategory.ordinal()] + entityPlayer.mobBackoffCounts[mobCategory.ordinal()]; // Paper - per player mob count backoff + } + // Paper end + +diff --git a/src/main/java/net/minecraft/server/level/ServerChunkCache.java b/src/main/java/net/minecraft/server/level/ServerChunkCache.java +index 488a253e218409b5f0b4a872cee0928578fa7582..acbcdc8cb1523044b1657e03a141fae6389a3686 100644 +--- a/src/main/java/net/minecraft/server/level/ServerChunkCache.java ++++ b/src/main/java/net/minecraft/server/level/ServerChunkCache.java +@@ -564,7 +564,17 @@ public class ServerChunkCache extends ChunkSource { + if ((this.spawnFriendlies || this.spawnEnemies) && this.chunkMap.playerMobDistanceMap != null) { // don't count mobs when animals and monsters are disabled + // re-set mob counts + for (ServerPlayer player : this.level.players) { +- Arrays.fill(player.mobCounts, 0); ++ // Paper start - per player mob spawning backoff ++ for (int ii = 0; ii < ServerPlayer.MOBCATEGORY_TOTAL_ENUMS; ii++) { ++ player.mobCounts[ii] = 0; ++ ++ int newBackoff = player.mobBackoffCounts[ii] - 1; // TODO make configurable bleed // TODO use nonlinear algorithm? ++ if (newBackoff < 0) { ++ newBackoff = 0; ++ } ++ player.mobBackoffCounts[ii] = newBackoff; ++ } ++ // Paper end - per player mob spawning backoff + } + spawnercreature_d = NaturalSpawner.createState(l, this.level.getAllEntities(), this::getFullChunk, null, true); + } else { +diff --git a/src/main/java/net/minecraft/server/level/ServerPlayer.java b/src/main/java/net/minecraft/server/level/ServerPlayer.java +index dc5fda83a66afbfeb7897fc20b4742899d8aca08..161c40692e8d469fad4169908b9353be0f85d0d8 100644 +--- a/src/main/java/net/minecraft/server/level/ServerPlayer.java ++++ b/src/main/java/net/minecraft/server/level/ServerPlayer.java +@@ -254,6 +254,7 @@ public class ServerPlayer extends Player { + // Paper start - mob spawning rework + public static final int MOBCATEGORY_TOTAL_ENUMS = net.minecraft.world.entity.MobCategory.values().length; + public final int[] mobCounts = new int[MOBCATEGORY_TOTAL_ENUMS]; // Paper ++ public final int[] mobBackoffCounts = new int[MOBCATEGORY_TOTAL_ENUMS]; // Paper - per player mob count backoff + public final com.destroystokyo.paper.util.PooledHashSets.PooledObjectLinkedOpenHashSet cachedSingleMobDistanceMap; + // Paper end + +diff --git a/src/main/java/net/minecraft/world/level/NaturalSpawner.java b/src/main/java/net/minecraft/world/level/NaturalSpawner.java +index 9ae2bd64514a83dbd8c22cc35a9ca4c39add5142..e85ddf92b4f6f044e2b5834a172f37d78e702ef3 100644 +--- a/src/main/java/net/minecraft/world/level/NaturalSpawner.java ++++ b/src/main/java/net/minecraft/world/level/NaturalSpawner.java +@@ -279,6 +279,11 @@ public final class NaturalSpawner { + + // Paper start + PreSpawnStatus doSpawning = isValidSpawnPostitionForType(world, group, structuremanager, chunkgenerator, biomesettingsmobs_c, blockposition_mutableblockposition, d2); ++ // Paper start - mob count backoff ++ if (doSpawning == PreSpawnStatus.ABORT || doSpawning == PreSpawnStatus.CANCELLED) { ++ world.getChunkSource().chunkMap.updateFailurePlayerMobTypeMap(blockposition_mutableblockposition.getX() >> 4, blockposition_mutableblockposition.getZ() >> 4, group); ++ } ++ // Paper end - mob count backoff + if (doSpawning == PreSpawnStatus.ABORT) { + return j; // Paper + } diff --git a/patches/server/1008-Deprecate-and-replace-methods-with-old-StructureType.patch b/patches/server/1009-Deprecate-and-replace-methods-with-old-StructureType.patch similarity index 100% rename from patches/server/1008-Deprecate-and-replace-methods-with-old-StructureType.patch rename to patches/server/1009-Deprecate-and-replace-methods-with-old-StructureType.patch diff --git a/patches/server/1009-Don-t-tab-complete-namespaced-commands-if-send-names.patch b/patches/server/1010-Don-t-tab-complete-namespaced-commands-if-send-names.patch similarity index 100% rename from patches/server/1009-Don-t-tab-complete-namespaced-commands-if-send-names.patch rename to patches/server/1010-Don-t-tab-complete-namespaced-commands-if-send-names.patch diff --git a/patches/server/1010-Properly-handle-BlockBreakEvent-isDropItems.patch b/patches/server/1011-Properly-handle-BlockBreakEvent-isDropItems.patch similarity index 100% rename from patches/server/1010-Properly-handle-BlockBreakEvent-isDropItems.patch rename to patches/server/1011-Properly-handle-BlockBreakEvent-isDropItems.patch diff --git a/patches/server/1011-Fire-entity-death-event-for-ender-dragon.patch b/patches/server/1012-Fire-entity-death-event-for-ender-dragon.patch similarity index 100% rename from patches/server/1011-Fire-entity-death-event-for-ender-dragon.patch rename to patches/server/1012-Fire-entity-death-event-for-ender-dragon.patch