From 2dc52f1d2e61c6ce2a8acf0a2d2ef218c4fb279e Mon Sep 17 00:00:00 2001 From: apple502j <33279053+apple502j@users.noreply.github.com> Date: Wed, 9 Feb 2022 20:30:19 +0900 Subject: [PATCH] Move, rename and document spawners (#2962) * Move, rename and document spawners * Apply suggestions from code review Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com> Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: haykam821 <24855774+haykam821@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../minecraft/world/gen/CatSpawner.mapping | 12 --------- .../world/gen/PhantomSpawner.mapping | 2 -- .../world/gen/PillagerSpawner.mapping | 8 ------ .../net/minecraft/world/gen/Spawner.mapping | 13 --------- .../world/spawner/CatSpawner.mapping | 27 +++++++++++++++++++ .../world/spawner/PatrolSpawner.mapping | 12 +++++++++ .../world/spawner/PhantomSpawner.mapping | 2 ++ .../minecraft/world/spawner/Spawner.mapping | 21 +++++++++++++++ 8 files changed, 62 insertions(+), 35 deletions(-) delete mode 100644 mappings/net/minecraft/world/gen/CatSpawner.mapping delete mode 100644 mappings/net/minecraft/world/gen/PhantomSpawner.mapping delete mode 100644 mappings/net/minecraft/world/gen/PillagerSpawner.mapping delete mode 100644 mappings/net/minecraft/world/gen/Spawner.mapping create mode 100644 mappings/net/minecraft/world/spawner/CatSpawner.mapping create mode 100644 mappings/net/minecraft/world/spawner/PatrolSpawner.mapping create mode 100644 mappings/net/minecraft/world/spawner/PhantomSpawner.mapping create mode 100644 mappings/net/minecraft/world/spawner/Spawner.mapping diff --git a/mappings/net/minecraft/world/gen/CatSpawner.mapping b/mappings/net/minecraft/world/gen/CatSpawner.mapping deleted file mode 100644 index e2a5768a20..0000000000 --- a/mappings/net/minecraft/world/gen/CatSpawner.mapping +++ /dev/null @@ -1,12 +0,0 @@ -CLASS net/minecraft/class_4274 net/minecraft/world/gen/CatSpawner - FIELD field_19171 ticksUntilNextSpawn I - FIELD field_30601 SPAWN_COOLDOWN I - METHOD method_20260 spawnInSwampHut (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;)I - ARG 1 world - ARG 2 pos - METHOD method_20262 spawn (Lnet/minecraft/class_2338;Lnet/minecraft/class_3218;)I - ARG 1 pos - ARG 2 world - METHOD method_20263 spawnInHouse (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;)I - ARG 1 world - ARG 2 pos diff --git a/mappings/net/minecraft/world/gen/PhantomSpawner.mapping b/mappings/net/minecraft/world/gen/PhantomSpawner.mapping deleted file mode 100644 index 6f4834b45e..0000000000 --- a/mappings/net/minecraft/world/gen/PhantomSpawner.mapping +++ /dev/null @@ -1,2 +0,0 @@ -CLASS net/minecraft/class_2910 net/minecraft/world/gen/PhantomSpawner - FIELD field_13244 ticksUntilNextSpawn I diff --git a/mappings/net/minecraft/world/gen/PillagerSpawner.mapping b/mappings/net/minecraft/world/gen/PillagerSpawner.mapping deleted file mode 100644 index c4b38cd6d3..0000000000 --- a/mappings/net/minecraft/world/gen/PillagerSpawner.mapping +++ /dev/null @@ -1,8 +0,0 @@ -CLASS net/minecraft/class_3769 net/minecraft/world/gen/PillagerSpawner - FIELD field_16652 ticksUntilNextSpawn I - METHOD method_16575 spawnPillager (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;Ljava/util/Random;Z)Z - ARG 1 world - ARG 2 pos - ARG 3 random - ARG 4 captain - COMMENT whether the pillager is the captain of a patrol diff --git a/mappings/net/minecraft/world/gen/Spawner.mapping b/mappings/net/minecraft/world/gen/Spawner.mapping deleted file mode 100644 index 9e8a974e4e..0000000000 --- a/mappings/net/minecraft/world/gen/Spawner.mapping +++ /dev/null @@ -1,13 +0,0 @@ -CLASS net/minecraft/class_5304 net/minecraft/world/gen/Spawner - COMMENT Handles spawning entities in a world. - COMMENT - COMMENT

A spawner is typically used to spawn entities within a special context, such as cats in a village or wandering traders. - METHOD method_6445 spawn (Lnet/minecraft/class_3218;ZZ)I - COMMENT Spawns entities into a world. - COMMENT - COMMENT @return the number of entities spawned - ARG 1 world - ARG 2 spawnMonsters - COMMENT whether monsters should be spawned - ARG 3 spawnAnimals - COMMENT whether animals should be spawned diff --git a/mappings/net/minecraft/world/spawner/CatSpawner.mapping b/mappings/net/minecraft/world/spawner/CatSpawner.mapping new file mode 100644 index 0000000000..da81c5f9b0 --- /dev/null +++ b/mappings/net/minecraft/world/spawner/CatSpawner.mapping @@ -0,0 +1,27 @@ +CLASS net/minecraft/class_4274 net/minecraft/world/spawner/CatSpawner + COMMENT A spawner for cats in villages and swamp huts. + COMMENT + COMMENT @implNote Cats in swamp huts are also spawned in + COMMENT {@link net.minecraft.world.gen.chunk.ChunkGeneratorSettings#getEntitySpawnList}. + FIELD field_19171 cooldown I + FIELD field_30601 SPAWN_INTERVAL I + METHOD method_20260 spawnInSwampHut (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;)I + COMMENT Tries to spawn cats in swamp huts. + COMMENT + COMMENT @return the number of cats spawned + ARG 1 world + ARG 2 pos + METHOD method_20262 spawn (Lnet/minecraft/class_2338;Lnet/minecraft/class_3218;)I + COMMENT Spawns a cat. + COMMENT + COMMENT @return the number of cats spawned + ARG 1 pos + ARG 2 world + METHOD method_20263 spawnInHouse (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;)I + COMMENT Tries to spawn cats in villages. + COMMENT + COMMENT @return the number of cats spawned + COMMENT + COMMENT @implNote Cats spawn when there are more than 5 occupied beds and less than 5 existing cats. + ARG 1 world + ARG 2 pos diff --git a/mappings/net/minecraft/world/spawner/PatrolSpawner.mapping b/mappings/net/minecraft/world/spawner/PatrolSpawner.mapping new file mode 100644 index 0000000000..6243ac35b9 --- /dev/null +++ b/mappings/net/minecraft/world/spawner/PatrolSpawner.mapping @@ -0,0 +1,12 @@ +CLASS net/minecraft/class_3769 net/minecraft/world/spawner/PatrolSpawner + COMMENT A spawner for pillager patrols. + COMMENT + COMMENT

Pillager spawns in pillager outposts are controlled at + COMMENT {@link net.minecraft.world.gen.chunk.ChunkGeneratorSettings#getEntitySpawnList}. + FIELD field_16652 cooldown I + METHOD method_16575 spawnPillager (Lnet/minecraft/class_3218;Lnet/minecraft/class_2338;Ljava/util/Random;Z)Z + ARG 1 world + ARG 2 pos + ARG 3 random + ARG 4 captain + COMMENT whether the pillager is the captain of a patrol diff --git a/mappings/net/minecraft/world/spawner/PhantomSpawner.mapping b/mappings/net/minecraft/world/spawner/PhantomSpawner.mapping new file mode 100644 index 0000000000..ba1d1d338c --- /dev/null +++ b/mappings/net/minecraft/world/spawner/PhantomSpawner.mapping @@ -0,0 +1,2 @@ +CLASS net/minecraft/class_2910 net/minecraft/world/spawner/PhantomSpawner + FIELD field_13244 cooldown I diff --git a/mappings/net/minecraft/world/spawner/Spawner.mapping b/mappings/net/minecraft/world/spawner/Spawner.mapping new file mode 100644 index 0000000000..c0524eacde --- /dev/null +++ b/mappings/net/minecraft/world/spawner/Spawner.mapping @@ -0,0 +1,21 @@ +CLASS net/minecraft/class_5304 net/minecraft/world/spawner/Spawner + COMMENT Spawns entities in a world. + COMMENT + COMMENT

A spawner is typically used to spawn entities within a + COMMENT special context, such as cats in a village or wandering traders. + COMMENT This is different from + COMMENT {@link net.minecraft.world.MobSpawnerLogic the mob spawner logic} + COMMENT which is used for {@link net.minecraft.SpawnerBlock the spawner block}, + COMMENT or the structure spawn conditions (such as guardians) which is defined in + COMMENT {@link net.minecraft.world.gen.chunk.ChunkGeneratorSettings#getEntitySpawnList}. + COMMENT However, cats in swamp huts are spawned in both {@link CatSpawner} and + COMMENT the normal structure spawning. + METHOD method_6445 spawn (Lnet/minecraft/class_3218;ZZ)I + COMMENT Spawns entities into a world. + COMMENT + COMMENT @return the number of entities spawned + ARG 1 world + ARG 2 spawnMonsters + COMMENT whether monsters should be spawned + ARG 3 spawnAnimals + COMMENT whether animals should be spawned