Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-28 03:48:01 +01:00
Code Issues Projects Releases Wiki Activity

SPIGOT-7080: Add World#locateNearestBiome

Browse Source 
By: Jishuna <joshl5324@gmail.com>
This commit is contained in:
Bukkit/Spigot 2023-10-09 20:11:42 +11:00
parent af63feab14
commit 199105c1d5
2 changed files with 85 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
paper-api/src/main/java/org/bukkit/World.java
View File

@ -33,6 +33,7 @@ import org.bukkit.metadata.Metadatable;
import org.bukkit.persistence.PersistentDataHolder;
import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.messaging.PluginMessageRecipient;
import org.bukkit.util.BiomeSearchResult;
import org.bukkit.util.BoundingBox;
import org.bukkit.util.RayTraceResult;
import org.bukkit.util.StructureSearchResult;
@ -2638,6 +2639,59 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
@Nullable
StructureSearchResult locateNearestStructure(@NotNull Location origin, @NotNull Structure structure, int radius, boolean findUnexplored);
/**
* Find the closest nearby location with a biome matching the provided
* {@link Biome}(s). Finding biomes can, and will, block if the world is looking
* in chunks that have not generated yet. This can lead to the world temporarily
* freezing while locating a biome.
* <p>
* <b>Note:</b> This will <i>not</i> reflect changes made to the world after
* generation, this method only sees the biome at the time of world generation.
* This will <i>not</i> load or generate chunks.
* <p>
* If multiple biomes are provided {@link BiomeSearchResult#getBiome()} will
* indicate which one was located.
* <p>
* This method will use a horizontal interval of 32 and a vertical interval of
* 64, equal to the /locate command.
*
* @param origin where to start looking for a biome
* @param radius the radius, in blocks, around which to search
* @param biomes the biomes to search for
* @return a BiomeSearchResult containing the closest {@link Location} and
* {@link Biome}, or null if no biome was found.
* @see #locateNearestBiome(Location, int, int, int, Biome...)
*/
@Nullable
BiomeSearchResult locateNearestBiome(@NotNull Location origin, int radius, @NotNull Biome... biomes);
/**
* Find the closest nearby location with a biome matching the provided
* {@link Biome}(s). Finding biomes can, and will, block if the world is looking
* in chunks that have not generated yet. This can lead to the world temporarily
* freezing while locating a biome.
* <p>
* <b>Note:</b> This will <i>not</i> reflect changes made to the world after
* generation, this method only sees the biome at the time of world generation.
* This will <i>not</i> load or generate chunks.
* <p>
* If multiple biomes are provided {@link BiomeSearchResult#getBiome()} will
* indicate which one was located. Higher values for {@code horizontalInterval}
* and {@code verticalInterval} will result in faster searches, but may lead to
* small biomes being missed.
*
* @param origin where to start looking for a biome
* @param radius the radius, in blocks, around which to search
* @param horizontalInterval the horizontal distance between each check
* @param verticalInterval the vertical distance between each check
* @param biomes the biomes to search for
* @return a BiomeSearchResult containing the closest {@link Location} and
* {@link Biome}, or null if no biome was found.
* @see #locateNearestBiome(Location, int, Biome...)
*/
@Nullable
BiomeSearchResult locateNearestBiome(@NotNull Location origin, int radius, int horizontalInterval, int verticalInterval, @NotNull Biome... biomes);
/**
* Finds the nearest raid close to the given location.
*

31
paper-api/src/main/java/org/bukkit/util/BiomeSearchResult.java Normal file
View File

@ -0,0 +1,31 @@
package org.bukkit.util;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.block.Biome;
import org.jetbrains.annotations.NotNull;
/**
* Holds the result of searching for a biome.
*
* @see World#locateNearestBiome(Location, int, Biome...)
* @see World#locateNearestBiome(Location, int, int, int, Biome...)
*/
public interface BiomeSearchResult {
/**
* Return the biome which was found.
*
* @return the found biome.
*/
@NotNull
Biome getBiome();
/**
* Return the location of the biome.
*
* @return the location the biome was found.
*/
@NotNull
Location getLocation();
}