From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Tue, 7 Jul 2020 10:53:22 -0700 Subject: [PATCH] More World API diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index 77314fdbd99a5cc34e7a1df4692ba8a1685ef002..f4d31d9d0f4cbd2621adf97a20b65ae83e5fd064 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -3849,6 +3849,122 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient @Nullable StructureSearchResult locateNearestStructure(@NotNull Location origin, @NotNull Structure structure, int radius, boolean findUnexplored); + // Paper start + /** + * Locates the nearest biome based on an origin, biome type, and radius to search. + * Step defaults to {@code 8}. + * + * @param origin Origin location + * @param biome Biome to find + * @param radius radius to search + * @return Location of biome or null if not found in specified radius + * @deprecated use {@link #locateNearestBiome(Location, int, Biome...)} + */ + @Deprecated + @Nullable + default Location locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius) { + return java.util.Optional.ofNullable(this.locateNearestBiome(origin, radius, 8, 8, biome)).map(BiomeSearchResult::getLocation).orElse(null); + } + + /** + * Locates the nearest biome based on an origin, biome type, and radius to search + * and step + * + * @param origin Origin location + * @param biome Biome to find + * @param radius radius to search + * @param step Search step 1 would mean checking every block, 8 would be every 8th block + * @return Location of biome or null if not found in specified radius + * @deprecated use {@link #locateNearestBiome(Location, int, int, int, Biome...)} + */ + @Deprecated + @Nullable + default Location locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius, int step) { + return java.util.Optional.ofNullable(this.locateNearestBiome(origin, radius, step, step, biome)).map(BiomeSearchResult::getLocation).orElse(null); + } + + /** + * Checks if the world: + * + * + * @return true if ultrawarm, false if not + * @deprecated use {@link #isUltraWarm()} + */ + @Deprecated(forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.21") + boolean isUltrawarm(); + + /** + * Gets the coordinate scaling of this world. + * + * @return the coordinate scale + */ + double getCoordinateScale(); + + /** + * Checks if the world has skylight access + * + * @return whether there is skylight + * @deprecated use {@link #hasSkyLight()} + */ + @Deprecated(forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.21") + boolean hasSkylight(); + + /** + * Checks if the world has a bedrock ceiling + * + * @return whether the world has a bedrock ceiling + * @deprecated use {@link #hasCeiling()} + */ + @Deprecated(forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.21") + boolean hasBedrockCeiling(); + + /** + * Checks if beds work + * + * @return whether beds work + * @deprecated use {@link #isBedWorks()} + */ + @Deprecated(forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.21") + boolean doesBedWork(); + + /** + * Checks if respawn anchors work + * + * @return whether respawn anchors work + * @deprecated use {@link #isRespawnAnchorWorks()} + */ + @Deprecated(forRemoval = true) @org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "1.21") + boolean doesRespawnAnchorWork(); + + /** + * Checks if this world has a fixed time + * + * @return whether this world has fixed time + */ + boolean isFixedTime(); + + /** + * Gets the collection of materials that burn infinitely in this world. + * + * @return the materials that will forever stay lit by fire + */ + @NotNull + Collection getInfiniburn(); + + /** + * Posts a specified game event at a location + * + * @param sourceEntity optional source entity + * @param gameEvent the game event to post + * @param position the position in the world where to post the event to listeners + */ + void sendGameEvent(@Nullable Entity sourceEntity, @NotNull GameEvent gameEvent, @NotNull Vector position); + // Paper end + // Spigot start @Deprecated(forRemoval = true) // Paper public class Spigot {