7d10cdea03
This PR contains all of Tuinity's patches. Very notable ones are: - Highly optimised collisions - Optimised entity lookups by bounding box (Mojang made regressions in 1.17, this brings it back to 1.16) - Starlight https://github.com/PaperMC/Starlight - Rewritten dataconverter system https://github.com/PaperMC/DataConverter - Random block ticking optimisation (wrongly dropped from Paper 1.17) - Chunk ticking optimisations - Anything else I've forgotten in the 60 or so patches If you are a previous Tuinity user, your config will not migrate. You must do it yourself. The config options have simply been moved into paper.yml, so it will be an easy migration. However, please note that the chunk loading options in tuinity.yml are NOT compatible with the options in paper.yml. * Port tuinity, initial patchset * Update gradle to 7.2 jmp said it fixes rebuildpatches not working for me. it fucking better * Completely clean apply * Remove tuinity config, add per player api patch * Remove paper reobf mappings patch * Properly update gradlew * Force clean rebuild * Mark fixups Comments and ATs still need to be done * grep -r "Tuinity" * Fixup * Ensure gameprofile lastaccess is written only under the state lock * update URL for dataconverter * Only clean rebuild tuinity patches might fix merge conflicts * Use UTF-8 for gradlew * Clean rb patches again * Convert block ids used as item ids Neither the converters of pre 1.13 nor DFU handled these cases, as by the time they were written the game at the time didn't consider these ids valid - they would be air. Because of this, some worlds have logspam since only DataConverter (not DFU or legacy converters) will warn when an invalid id has been seen. While quite a few do need to now be considered as air, quite a lot do not. So it makes sense to add conversion for these items, instead of simply suppressing or ignoring the logs. I've now added id -> string conversion for all block ids that could be used as items that existed in the game before 1.7.10 (I have no interest in tracking down the exact version block ids stopped working) that were on https://minecraft-ids.grahamedgecombe.com/ Items that did not directly convert to new items will be instead converted to air: stems, wheat crops, piston head, tripwire wire block * Fix LightPopulated parsing in V1466 The DFU code was checking if the number existed, not if it didn't exist. I misread the original code. * Always parse protochunk light sources unless it is marked as non-lit Chunks not marked as lit will always go through the light engine, so they should always have their block sources parsed. * Update custom names to JSON for players Missed this fix from CB, as it was inside the DataFixers class. I decided to double check all of the CB changes again: DataFixers.java was the only area I missed, as I had inspected all datafixer diffs and implemented them all into DataConverter. I also checked Bootstrap.java again, and re-evaluated their changes. I had previously done this, but determined that they were all bad. The changes to make standing_sign block map to oak_sign block in V1450 is bad, because that's not the item id V1450 accepts. Only in 1.14 did oak_sign even exist, and as expected there is a converter to rename all existing sign items/blocks. The fix to register the portal block under id 1440 is useless, as the flattenning logic will default to the lowest registered id - which is the exact blockstate that CB registers into 1440. So it just doesn't do anything. The extra item ids in the id -> string converter are already added, but I found this from EMC originally. The change for the spawn egg id 23 -> Arrow is just wrong, that id DOES correspond to TippedArrow, NOT Arrow. As expected, the spawn egg already has a dedicated mapping for Arrow, which is id 10 - which was Arrow's entity id. I also ported a fix for the cooked_fished id update. This doesn't really matter since there is already a dataconverter to fix this, but the game didn't accept cooked_fished at the time. So I see no harm. * Review all converters and walkers - Refactor V99 to have helper methods for defining entity/tile entity types - Automatically namespace all ids that should be namespaced. While vanilla never saved non-namespaced data for things that are namespaced, plugins/users might have. - Synchronised the identity ensure map in HelperBlockFlatteningV1450 - Code style consistency - Add missing log warning in V102 for ITEM_NAME type conversion - Use getBoolean instead of getByte - Use ConverterAbstractEntityRename for V143 TippedArrow -> Arrow rename, as it will affect ENTITY_NAME type - Always set isVillager to false in V502 for Zombie - Register V808's converter under subversion 1 like DFU - Register a breakpoint for V1.17.1. In the future, all final versions of major releases will have a breakpoint so that the work required to determine if a converter needs a breakpoint is minimal - Validate that a dataconverter is only registered for a version that is registered - ConverterFlattenTileEntity is actually ConverterFlattenEntity It even registered the converters under TILE_ENTITY, instead of ENTITY. - Fix id comparison in V1492 STRUCTURE_FEATURE renamer - Use ConverterAbstractStatsRename for V1510 stats renamer At the time I had written that class, the abstract renamer didn't exist. - Ensure OwnerUUID is at least set to empty string in V1904 if the ocelot is converted to a cat (this is likely so that it retains a collar) - Use generic read/write for Records in V1946 Records is actually a list, not a map. So reading map was invalid. * Always set light to zero when propagating decrease This fixes an almost infinite loop where light values would be spam queued on a very small subset on blocks. This also likely fixes the memory issues people were seeing. * re-organize patches * Apply and fix conflicts * Revert some patches getChunkAt retains chunks so that plugins don't spam loads revert mc-4 fix will remain unless issues pop up * Shuffle iterated chunks if per player is not enabled Can help with some mob spawning stacking up at locations * Make per player default, migrate all configs * Adjust comments in fixups * Rework config for player chunk loader Old config is not compatible. Move all configs to be under `settings` in paper.yml The player chunk loader has been modified to less aggressively load chunks, but to send chunks at higher rates compared to tuinity. There are new config entries to tune this behavior. * Add back old constructor to CompressionEncoder/Decoder (fixes Tuinity #358) * Raise chunk loading default limits * Reduce worldgen thread workers for lower core count cpus * Raise limits for chunk loading config Also place it under `chunk-loading` * Disable max chunk send rate by default * Fix conflicts and rebuild patches * Drop default send rate again Appears to be still causing problems for no known reason * Raise chunk send limits to 100 per player While a low limit fixes ping issues for some people, most people do not suffer from this issue and thus should not suffer from an extremely slow load-in rate. * Rebase part 1 Autosquash the fixups * Move not implemented up * Fixup mc-dev fixes Missed this one * Rebase per player viewdistance api into the original api patch * Remove old light engine patch part 1 The prioritisation must be kept from it, so that part has been rebased into the priority patch. Part 2 will deal with rebasing all of the patches _after_ * Rebase remaining patches for old light patch removal * Remove other mid tick patch * Remove Optimize-PlayerChunkMap-memory-use-for-visibleChunks.patch Replaced by `Do not copy visible chunks` * Revert AT for Vec3i setX/Y/Z The class is immutable. set should not be exposed * Remove old IntegerUtil class * Replace old CraftChunk#getEntities patch * Remove import for SWMRNibbleArray in ChunkAccess * Finished merge checklist * Remove ensureTickThread impl in urgency patch Co-authored-by: Spottedleaf <Spottedleaf@users.noreply.github.com> Co-authored-by: Jason Penilla <11360596+jpenilla@users.noreply.github.com>
511 Zeilen
19 KiB
Diff
511 Zeilen
19 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: dfsek <dfsek@protonmail.com>
|
|
Date: Sat, 19 Jun 2021 20:15:29 -0700
|
|
Subject: [PATCH] Add more LimitedRegion API
|
|
|
|
|
|
diff --git a/src/main/java/io/papermc/paper/world/generation/ProtoWorld.java b/src/main/java/io/papermc/paper/world/generation/ProtoWorld.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..edf8d0ae398f123ab25cb7954df07f6020454dd4
|
|
--- /dev/null
|
|
+++ b/src/main/java/io/papermc/paper/world/generation/ProtoWorld.java
|
|
@@ -0,0 +1,319 @@
|
|
+package io.papermc.paper.world.generation;
|
|
+
|
|
+import org.bukkit.World;
|
|
+import org.bukkit.block.BlockState;
|
|
+import org.bukkit.block.data.BlockData;
|
|
+import org.bukkit.entity.Entity;
|
|
+import org.bukkit.entity.EntityType;
|
|
+import org.bukkit.event.entity.CreatureSpawnEvent;
|
|
+import org.bukkit.generator.LimitedRegion;
|
|
+import org.bukkit.generator.WorldInfo;
|
|
+import org.bukkit.util.Vector;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+import org.jetbrains.annotations.Nullable;
|
|
+
|
|
+import java.util.Random;
|
|
+import java.util.function.Consumer;
|
|
+
|
|
+/**
|
|
+ * Represents a small grid of chunks in a {@link World}
|
|
+ * with rudimentary block and entity access, for use during world generation.
|
|
+ * <p>
|
|
+ * A ProtoWorld is guaranteed read/write access to a 3x3 grid of chunks,
|
|
+ * but may have access to a grid as large as 17x17. It is safest to assume
|
|
+ * that there is only read/write access to 3x3 chunks. Some chunks outside
|
|
+ * of the 3x3 area may be readable but not writable.
|
|
+ * <p>
|
|
+ * ProtoWorlds should not be stored! After they are used during
|
|
+ * chunk generation they should be disposed of.
|
|
+ *
|
|
+ * @see org.bukkit.generator.BlockPopulator#populate(WorldInfo, Random, int, int, LimitedRegion)
|
|
+ * @deprecated see {@link org.bukkit.RegionAccessor} and {@link org.bukkit.generator.LimitedRegion}
|
|
+ */
|
|
+@Deprecated(forRemoval = true)
|
|
+public interface ProtoWorld {
|
|
+ /**
|
|
+ * Sets the block at (x, y, z) to the provided {@link BlockData}.
|
|
+ *
|
|
+ * @param x X coordinate in this ProtoWorld
|
|
+ * @param y Y coordinate in this ProtoWorld
|
|
+ * @param z Z coordinate in this ProtoWorld
|
|
+ * @param data {@link BlockData} to set the block at the provided coordinates to.
|
|
+ */
|
|
+ void setBlockData(int x, int y, int z, @NotNull BlockData data);
|
|
+
|
|
+ /**
|
|
+ * Sets the block at a vector location to the provided {@link BlockData}.
|
|
+ *
|
|
+ * @param vector {@link Vector} representing the position of the block to set.
|
|
+ * @param data {@link BlockData} to set the block at the provided coordinates to.
|
|
+ */
|
|
+ default void setBlockData(@NotNull Vector vector, @NotNull BlockData data) {
|
|
+ setBlockData(vector.getBlockX(), vector.getBlockY(), vector.getBlockZ(), data);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Sets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param x X coordinate.
|
|
+ * @param y Y coordinate.
|
|
+ * @param z Z coordinate.
|
|
+ * @param state The block state.
|
|
+ */
|
|
+ void setBlockState(int x, int y, int z, @NotNull BlockState state);
|
|
+
|
|
+ /**
|
|
+ * Sets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param location Location to set block state.
|
|
+ * @param state The block state.
|
|
+ */
|
|
+ default void setBlockState(@NotNull Vector location, @NotNull BlockState state) {
|
|
+ setBlockState(location.getBlockX(), location.getBlockY(), location.getBlockZ(), state);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param x X coordinate.
|
|
+ * @param y Y coordinate.
|
|
+ * @param z Z coordinate.
|
|
+ * @return The block state.
|
|
+ */
|
|
+ @NotNull
|
|
+ BlockState getBlockState(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Gets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param location Location to get block state from.
|
|
+ * @return The block state.
|
|
+ */
|
|
+ @NotNull
|
|
+ default BlockState getBlockState(@NotNull Vector location) {
|
|
+ return getBlockState(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Schedule a block update at (x, y, z).
|
|
+ *
|
|
+ * @param x X coordinate in this ProtoWorld
|
|
+ * @param y Y coordinate in this ProtoWorld
|
|
+ * @param z Z coordinate in this ProtoWorld
|
|
+ */
|
|
+ void scheduleBlockUpdate(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Schedule a block update at a vector location
|
|
+ *
|
|
+ * @param location {@link Vector} representing the position of the block to update.
|
|
+ */
|
|
+ default void scheduleBlockUpdate(@NotNull Vector location) {
|
|
+ scheduleBlockUpdate(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Schedule a fluid update at (x, y, z).
|
|
+ *
|
|
+ * @param x X coordinate in this ProtoWorld
|
|
+ * @param y Y coordinate in this ProtoWorld
|
|
+ * @param z Z coordinate in this ProtoWorld
|
|
+ */
|
|
+ void scheduleFluidUpdate(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Schedule a fluid update at a vector location
|
|
+ *
|
|
+ * @param location {@link Vector} representing the position of the block to update.
|
|
+ */
|
|
+ default void scheduleFluidUpdate(@NotNull Vector location) {
|
|
+ scheduleFluidUpdate(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Get the {@link World} object this ProtoWorld represents.
|
|
+ * <p>
|
|
+ * Do <b>not</b> attempt to read from/write to this world! Doing so during generation <b>will cause a deadlock!</b>
|
|
+ *
|
|
+ * @return The {@link World} object that this ProtoWorld represents.
|
|
+ */
|
|
+ @NotNull
|
|
+ World getWorld();
|
|
+
|
|
+
|
|
+ /**
|
|
+ * Get the {@link BlockData} of the block at the provided coordinates.
|
|
+ *
|
|
+ * @param x X coordinate in this ProtoWorld
|
|
+ * @param y Y coordinate in this ProtoWorld
|
|
+ * @param z Z coordinate in this ProtoWorld
|
|
+ * @return {@link BlockData} at the coordinates
|
|
+ */
|
|
+ @NotNull
|
|
+ BlockData getBlockData(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Get the {@link BlockData} of the block at the provided coordinates.
|
|
+ *
|
|
+ * @param vector {@link Vector} representing the position of the block to get.
|
|
+ * @return {@link BlockData} at the coordinates
|
|
+ */
|
|
+ @NotNull
|
|
+ default BlockData getBlockData(@NotNull Vector vector) {
|
|
+ return getBlockData(vector.getBlockX(), vector.getBlockY(), vector.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Get the X-coordinate of the chunk in the center of this ProtoWorld
|
|
+ *
|
|
+ * @return The center chunk's X coordinate.
|
|
+ */
|
|
+ int getCenterChunkX();
|
|
+
|
|
+ /**
|
|
+ * Get the X-coordinate of the block in the center of this {@link ProtoWorld}
|
|
+ *
|
|
+ * @return The center chunk's X coordinate.
|
|
+ */
|
|
+ default int getCenterBlockX() {
|
|
+ return getCenterChunkX() << 4;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Get the Z-coordinate of the chunk in the center of this {@link ProtoWorld}
|
|
+ *
|
|
+ * @return The center chunk's Z coordinate.
|
|
+ */
|
|
+ int getCenterChunkZ();
|
|
+
|
|
+ /**
|
|
+ * Get the Z-coordinate of the block in the center of this {@link ProtoWorld}
|
|
+ *
|
|
+ * @return The center chunk's Z coordinate.
|
|
+ */
|
|
+ default int getCenterBlockZ() {
|
|
+ return getCenterChunkZ() << 4;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Creates an entity at the location represented by the given {@link Vector}
|
|
+ *
|
|
+ * @param loc The {@link Vector} representing the location to spawn the entity
|
|
+ * @param type The entity to spawn
|
|
+ * @return Resulting Entity of this method
|
|
+ */
|
|
+ @NotNull
|
|
+ default Entity spawnEntity(@NotNull Vector loc, @NotNull EntityType type) {
|
|
+ return spawn(loc, type.getEntityClass(), CreatureSpawnEvent.SpawnReason.DEFAULT);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Spawn an entity of a specific class at location represented by the given {@link Vector}
|
|
+ *
|
|
+ * @param location The {@link Vector} representing the location to spawn the entity at
|
|
+ * @param clazz The class of the {@link Entity} to spawn
|
|
+ * @param <T> The class of the {@link Entity} to spawn
|
|
+ * @return An instance of the spawned {@link Entity}
|
|
+ * @throws IllegalArgumentException if either parameter is null or the
|
|
+ * {@link Entity} requested cannot be spawned
|
|
+ */
|
|
+ @NotNull
|
|
+ default <T extends Entity> T spawn(@NotNull Vector location, @NotNull Class<T> clazz) throws IllegalArgumentException {
|
|
+ return spawn(location, clazz, CreatureSpawnEvent.SpawnReason.DEFAULT, null);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Spawn an entity of a specific class at location represented by the given {@link Vector}
|
|
+ *
|
|
+ * @param location The {@link Vector} representing the location to spawn the entity at
|
|
+ * @param clazz The class of the {@link Entity} to spawn
|
|
+ * @param <T> The class of the {@link Entity} to spawn
|
|
+ * @param reason The reason for the entity's spawn.
|
|
+ * @return An instance of the spawned {@link Entity}
|
|
+ * @throws IllegalArgumentException if either parameter is null or the
|
|
+ * {@link Entity} requested cannot be spawned
|
|
+ */
|
|
+ @NotNull
|
|
+ default <T extends Entity> T spawn(@NotNull Vector location, @NotNull Class<T> clazz, @NotNull CreatureSpawnEvent.SpawnReason reason) throws IllegalArgumentException {
|
|
+ return spawn(location, clazz, reason, null);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Spawn an entity of a specific class at the location represented by the given {@link Vector}, 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.
|
|
+ *
|
|
+ * @param location The {@link Vector} representing the location to spawn the entity at
|
|
+ * @param clazz The class of the {@link Entity} to spawn
|
|
+ * @param function The function to be run before the entity is spawned.
|
|
+ * @param <T> The class of the {@link Entity} to spawn
|
|
+ * @return An instance of the spawned {@link Entity}
|
|
+ * @throws IllegalArgumentException if either parameter is null or the
|
|
+ * {@link Entity} requested cannot be spawned
|
|
+ */
|
|
+ @NotNull
|
|
+ default <T extends Entity> T spawn(@NotNull Vector location, @NotNull Class<T> clazz, @Nullable Consumer<T> function) throws IllegalArgumentException {
|
|
+ return spawn(location, clazz, CreatureSpawnEvent.SpawnReason.CUSTOM, function);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Spawn an entity of a specific class at the location represented by the given {@link Vector}, 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.
|
|
+ *
|
|
+ * @param location The {@link Vector} representing the location to spawn the entity at
|
|
+ * @param clazz The class of the {@link Entity} to spawn
|
|
+ * @param reason The reason for the entity's spawn.
|
|
+ * @param function The function to be run before the entity is spawned.
|
|
+ * @param <T> The class of the {@link Entity} to spawn
|
|
+ * @return An instance of the spawned {@link Entity}
|
|
+ * @throws IllegalArgumentException if either parameter is null or the
|
|
+ * {@link Entity} requested cannot be spawned
|
|
+ */
|
|
+ @NotNull
|
|
+ default <T extends Entity> T spawn(@NotNull Vector location, @NotNull Class<T> clazz, @NotNull CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<T> function) throws IllegalArgumentException {
|
|
+ return spawn(location, clazz, function, reason);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Creates an entity at the location represented by the given {@link Vector}
|
|
+ *
|
|
+ * @param loc The {@link Vector} representing the location to spawn the entity
|
|
+ * @param type The entity to spawn
|
|
+ * @param reason The reason for the entity's spawn.
|
|
+ * @return Resulting Entity of this method
|
|
+ */
|
|
+ @SuppressWarnings("unchecked")
|
|
+ @NotNull
|
|
+ default Entity spawnEntity(@NotNull Vector loc, @NotNull EntityType type, @NotNull CreatureSpawnEvent.SpawnReason reason) {
|
|
+ return spawn(loc, (Class<Entity>) type.getEntityClass(), reason, null);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Creates an entity at the location represented by the given {@link Vector}, 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.
|
|
+ *
|
|
+ * @param loc The {@link Vector} representing the location to spawn the entity
|
|
+ * @param type The entity to spawn
|
|
+ * @param reason The reason for the entity's spawn.
|
|
+ * @param function The function to be run before the entity is spawned.
|
|
+ * @return Resulting Entity of this method
|
|
+ */
|
|
+ @SuppressWarnings("unchecked")
|
|
+ @NotNull
|
|
+ default Entity spawnEntity(@NotNull Vector loc, @NotNull EntityType type, @NotNull CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<Entity> function) {
|
|
+ return spawn(loc, (Class<Entity>) type.getEntityClass(), reason, function);
|
|
+ }
|
|
+
|
|
+ @NotNull <T extends Entity> T spawn(@NotNull Vector location, @NotNull Class<T> clazz, @Nullable Consumer<T> function, @NotNull CreatureSpawnEvent.SpawnReason reason) throws IllegalArgumentException;
|
|
+}
|
|
diff --git a/src/main/java/org/bukkit/generator/ChunkGenerator.java b/src/main/java/org/bukkit/generator/ChunkGenerator.java
|
|
index 0667315e2bd10254aef59c2a6bcceee9d927b6d5..e96d8877f73de12a56a2b36e32381a0b48bce297 100644
|
|
--- a/src/main/java/org/bukkit/generator/ChunkGenerator.java
|
|
+++ b/src/main/java/org/bukkit/generator/ChunkGenerator.java
|
|
@@ -343,6 +343,20 @@ public abstract class ChunkGenerator {
|
|
return new ArrayList<BlockPopulator>();
|
|
}
|
|
|
|
+
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Generate decorations in a chunk, with quick access to its neighbors.
|
|
+ *
|
|
+ * @param world ProtoWorld to generate decorations with.
|
|
+ * @deprecated use and override {@link BlockPopulator#populate(WorldInfo, Random, int, int, LimitedRegion)}
|
|
+ */
|
|
+ @Deprecated(forRemoval = true)
|
|
+ public void generateDecorations(@NotNull io.papermc.paper.world.generation.ProtoWorld world) {
|
|
+ // Do nothing by default to maintain compatibility with existing generators.
|
|
+ }
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Gets a fixed spawn location to use for a given world.
|
|
* <p>
|
|
diff --git a/src/main/java/org/bukkit/generator/LimitedRegion.java b/src/main/java/org/bukkit/generator/LimitedRegion.java
|
|
index 0428f210866587997d3e73dbb6ae4770f3c44ed5..3bd9f092d9ae38c2d91abdc522d6a8d94b4b8212 100644
|
|
--- a/src/main/java/org/bukkit/generator/LimitedRegion.java
|
|
+++ b/src/main/java/org/bukkit/generator/LimitedRegion.java
|
|
@@ -2,6 +2,12 @@ package org.bukkit.generator;
|
|
|
|
import org.bukkit.Location;
|
|
import org.bukkit.RegionAccessor;
|
|
+// Paper start
|
|
+import org.bukkit.World;
|
|
+import org.bukkit.block.BlockState;
|
|
+import org.bukkit.block.data.BlockData;
|
|
+import org.bukkit.util.Vector;
|
|
+// Paper end
|
|
import org.jetbrains.annotations.NotNull;
|
|
|
|
/**
|
|
@@ -42,4 +48,136 @@ public interface LimitedRegion extends RegionAccessor {
|
|
* @return true if the coordinates are in the region, otherwise false.
|
|
*/
|
|
boolean isInRegion(int x, int y, int z);
|
|
+
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Sets the block at a vector location to the provided {@link BlockData}.
|
|
+ *
|
|
+ * @param vector {@link Vector} representing the position of the block to set.
|
|
+ * @param data {@link BlockData} to set the block at the provided coordinates to.
|
|
+ */
|
|
+ default void setBlockData(@NotNull Vector vector, @NotNull BlockData data) {
|
|
+ setBlockData(vector.getBlockX(), vector.getBlockY(), vector.getBlockZ(), data);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Sets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param x X coordinate.
|
|
+ * @param y Y coordinate.
|
|
+ * @param z Z coordinate.
|
|
+ * @param state The block state.
|
|
+ */
|
|
+ void setBlockState(int x, int y, int z, @NotNull BlockState state);
|
|
+
|
|
+ /**
|
|
+ * Sets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param location Location to set block state.
|
|
+ * @param state The block state.
|
|
+ */
|
|
+ default void setBlockState(@NotNull Vector location, @NotNull BlockState state) {
|
|
+ setBlockState(location.getBlockX(), location.getBlockY(), location.getBlockZ(), state);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the {@link BlockState} at a location.
|
|
+ *
|
|
+ * @param location Location to get block state from.
|
|
+ * @return The block state.
|
|
+ */
|
|
+ @NotNull
|
|
+ default BlockState getBlockState(@NotNull Vector location) {
|
|
+ return getBlockState(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Schedules a block update at (x, y, z).
|
|
+ *
|
|
+ * @param x X coordinate
|
|
+ * @param y Y coordinate
|
|
+ * @param z Z coordinate
|
|
+ */
|
|
+ void scheduleBlockUpdate(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Schedules a block update at a vector location.
|
|
+ *
|
|
+ * @param location {@link Vector} representing the position of the block to update.
|
|
+ */
|
|
+ default void scheduleBlockUpdate(@NotNull Vector location) {
|
|
+ scheduleBlockUpdate(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Schedules a fluid update at (x, y, z).
|
|
+ *
|
|
+ * @param x X coordinate
|
|
+ * @param y Y coordinate
|
|
+ * @param z Z coordinate
|
|
+ */
|
|
+ void scheduleFluidUpdate(int x, int y, int z);
|
|
+
|
|
+ /**
|
|
+ * Schedules a fluid update at a vector location.
|
|
+ *
|
|
+ * @param location {@link Vector} representing the position of the block to update.
|
|
+ */
|
|
+ default void scheduleFluidUpdate(@NotNull Vector location) {
|
|
+ scheduleFluidUpdate(location.getBlockX(), location.getBlockY(), location.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the {@link World} object this region represents.
|
|
+ * <p>
|
|
+ * Do <b>not</b> attempt to read from/write to this world! Doing so during generation <b>will cause a deadlock!</b>
|
|
+ *
|
|
+ * @return The {@link World} object that this region represents.
|
|
+ */
|
|
+ @NotNull
|
|
+ World getWorld();
|
|
+
|
|
+ /**
|
|
+ * Gets the {@link BlockData} of the block at the provided coordinates.
|
|
+ *
|
|
+ * @param vector {@link Vector} representing the position of the block to get.
|
|
+ * @return {@link BlockData} at the coordinates
|
|
+ */
|
|
+ @NotNull
|
|
+ default BlockData getBlockData(@NotNull Vector vector) {
|
|
+ return getBlockData(vector.getBlockX(), vector.getBlockY(), vector.getBlockZ());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the X-coordinate of the chunk in the center of the region.
|
|
+ *
|
|
+ * @return The center chunk's X coordinate.
|
|
+ */
|
|
+ int getCenterChunkX();
|
|
+
|
|
+ /**
|
|
+ * Gets the X-coordinate of the block in the center of the region.
|
|
+ *
|
|
+ * @return The center chunk's X coordinate.
|
|
+ */
|
|
+ default int getCenterBlockX() {
|
|
+ return getCenterChunkX() << 4;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the Z-coordinate of the chunk in the center of the region.
|
|
+ *
|
|
+ * @return The center chunk's Z coordinate.
|
|
+ */
|
|
+ int getCenterChunkZ();
|
|
+
|
|
+ /**
|
|
+ * Gets the Z-coordinate of the block in the center of the region.
|
|
+ *
|
|
+ * @return The center chunk's Z coordinate.
|
|
+ */
|
|
+ default int getCenterBlockZ() {
|
|
+ return getCenterChunkZ() << 4;
|
|
+ }
|
|
+ // Paper end
|
|
}
|