Package net.tnemc.plugincore.core.compatibility

Interface ChunkProvider

All Known Implementing Classes:
BukkitChunkProvider, PaperChunkProvider, SpongeChunkProvider
public interface ChunkProvider
ChunkProvider
Since:
1.1.0.1
Author:
creatorfromhell

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsBiome(@NotNull String biome)
    Checks if the specified biome is contained within the chunk provider.
    default boolean
    containsBiomes(@NotNull List<String> biomes)
    Checks if the provided list of biomes contains any of the specified biomes.
    boolean
    containsStructure(@NotNull String structure)
    Checks if the provided structure is contained.
    default boolean
    containsStructures(@NotNull List<String> structures)
    Checks if the provided list of structures contains any structures.
    boolean
    isSlime()
    Checks if the ChunkProvider represents a slime chunk.
    int
    x()
    This method is used to get the chunk's x coordinate.
    default int
    y()
    This method is used to get the chunk's y coordinate.
    int
    z()
    This method is responsible for returning a value of type int.

  • Method Details

    • x

      int x()
      This method is used to get the chunk's x coordinate.
      Returns:
      The chunk's x coordinate.

    • y

      default int y()
      This method is used to get the chunk's y coordinate.
      Returns:
      The chunk's y coordinate.

    • z

      int z()
      This method is responsible for returning a value of type int. The specific logic and calculations performed to determine this value are not documented.
      Returns:
      The integer value calculated by the method.

    • isSlime

      boolean isSlime()
      Checks if the ChunkProvider represents a slime chunk.
      Returns:
      True if the ChunkProvider is a slime chunk, false otherwise.

    • containsBiome

      boolean containsBiome(@NotNull @NotNull String biome)
      Checks if the specified biome is contained within the chunk provider.
      Parameters:
      biome - The biome to check for.
      Returns:
      True if the specified biome is contained, false otherwise.

    • containsBiomes

      default boolean containsBiomes(@NotNull @NotNull List<String> biomes)
      Checks if the provided list of biomes contains any of the specified biomes.
      Parameters:
      biomes - The list of biomes to check for.
      Returns:
      True if any of the specified biomes are contained in the list, false otherwise.

    • containsStructure

      boolean containsStructure(@NotNull @NotNull String structure)
      Checks if the provided structure is contained.
      Parameters:
      structure - The structure to check if contained.
      Returns:
      True if the structure is contained, false otherwise.

    • containsStructures

      default boolean containsStructures(@NotNull @NotNull List<String> structures)
      Checks if the provided list of structures contains any structures.
      Parameters:
      structures - The list of structures to check for.
      Returns:
      True if any of the structures are contained in the list, false otherwise.