Spigot / Bukkit / 1851857b78b

Commits

DerFrZocker authored and md_5 committed 1851857b78b 31 Jan 2024

SPIGOT-3071, #969: Add entity spawn method with spawn reason

src/main/java/org/bukkit/World.java

Modified

-14
+import org.bukkit.boss.DragonBattle;
-15
+import org.bukkit.entity.AbstractArrow;
-16
+import org.bukkit.entity.Arrow;
-17
+import org.bukkit.entity.Entity;
-18
+import org.bukkit.entity.FallingBlock;
-19
+import org.bukkit.entity.Item;
-20
+import org.bukkit.entity.LightningStrike;
-21
+import org.bukkit.entity.LivingEntity;
-22
+import org.bukkit.entity.Player;
-23
+import org.bukkit.entity.SpawnCategory;
-+
+import org.bukkit.event.entity.CreatureSpawnEvent;
-25
+import org.bukkit.generator.BiomeProvider;
-26
+import org.bukkit.generator.BlockPopulator;
-27
+import org.bukkit.generator.ChunkGenerator;
-28
+import org.bukkit.generator.WorldInfo;
-29
+import org.bukkit.generator.structure.Structure;
-30
+import org.bukkit.generator.structure.StructureType;
-31
+import org.bukkit.inventory.ItemStack;
-32
+import org.bukkit.material.MaterialData;
-33
+import org.bukkit.metadata.Metadatable;
-34
+import org.bukkit.persistence.PersistentDataHolder;
-1172
+    public void save();
-1173
-1174
+    /**
-1175
+     * Gets a list of all applied {@link BlockPopulator}s for this World
-1176
+     *
-1177
+     * @return List containing any or none BlockPopulators
-1178
+     */
-1179
+    @NotNull
-1180
+    public List<BlockPopulator> getPopulators();
-1181
-+
+    /**
-+
+     * Creates a new entity at the given {@link Location} with the supplied
-+
+     * function run before the entity is added to the world.
-+
+     * <br>
-+
+     * Note that when the function is run, the entity will not be actually in
-+
+     * the world. Any operation involving such as teleporting the entity is undefined
-+
+     * until after this function returns.
-+
+     * The passed function however is run after the potential entity's spawn
-+
+     * randomization and hence already allows access to the values of the mob,
-+
+     * whether or not those were randomized, such as attributes or the entity
-+
+     * equipment.
-+
+     *
-+
+     * @param location      the location at which the entity will be spawned.
-+
+     * @param clazz         the class of the {@link LivingEntity} that is to be spawned.
-+
+     * @param <T>           the generic type of the entity that is being created.
-+
+     * @param spawnReason   the reason provided during the {@link CreatureSpawnEvent} call.
-+
+     * @param randomizeData whether or not the entity's data should be randomised
-+
+     *                      before spawning. By default entities are randomised
-+
+     *                      before spawning in regards to their equipment, age,
-+
+     *                      attributes, etc.
-+
+     *                      An example of this randomization would be the color of
-+
+     *                      a sheep, random enchantments on the equipment of mobs
-+
+     *                      or even a zombie becoming a chicken jockey.
-+
+     *                      If set to false, the entity will not be randomised
-+
+     *                      before spawning, meaning all their data will remain
-+
+     *                      in their default state and not further modifications
-+
+     *                      to the entity will be made.
-+
+     *                      Notably only entities that extend the
-+
+     *                      {@link org.bukkit.entity.Mob} interface provide
-+
+     *                      randomisation logic for their spawn.
-+
+     *                      This parameter is hence useless for any other type
-+
+     *                      of entity.
-+
+     * @param function      the function to be run before the entity is spawned.
-+
+     * @return the spawned entity instance.
-+
+     * @throws IllegalArgumentException if either the world or clazz parameter are null.
-+
+     */
-+
+    @NotNull
-+
+    public <T extends LivingEntity> T spawn(@NotNull Location location, @NotNull Class<T> clazz, @NotNull CreatureSpawnEvent.SpawnReason spawnReason, boolean randomizeData, @Nullable Consumer<? super T> function) throws IllegalArgumentException;
-+
-1221
+    /**
-1222
+     * Spawn a {@link FallingBlock} entity at the given {@link Location} of
-1223
+     * the specified {@link MaterialData}. The MaterialData dictates what is falling.
-1224
+     * When the FallingBlock hits the ground, it will place that block.
-1225
+     * <p>
-1226
+     * The Material must be a block type, check with {@link Material#isBlock()
-1227
+     * data.getItemType().isBlock()}. The Material may not be air.
-1228
+     *
-1229
+     * @param location The {@link Location} to spawn the FallingBlock
-1230
+     * @param data The block data

Bukkit

Commits

Jira Issues

Add shortcut