Interface BiomeRegistry

@NullMarked @AsOf("0.0.1") public interface BiomeRegistry
An interface for registering and modifying custom biomes on a Minecraft server.
Since:
0.0.1

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final WireProvider<BiomeRegistry>
    WIRE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    buildDelegate(Biome biome)
    Builds a custom biome into a minecraft biome.
    <T extends Biome>
    T
    getBiome(ResourceKey key)
    Gets an abstract biome from the registry.
    default void
    modify(Biome... biomes)
    This method modifies an existing biome on the Minecraft server.
    void
    modify(Collection<Biome> biomes)
    Modifies a collection of existing biomes on the Minecraft server.
    default void
    register(Biome... biomes)
    This method registers a custom biome to a Minecraft server.
    void
    register(Collection<Biome> biomes)
    Registers a collection of custom biomes to a Minecraft server.
    static BiomeRegistry
    registry()
    This static method returns the current BiomeRegistry instance.

  • Field Details

  • Method Details

    • registry

      @AsOf("2.3.0") static BiomeRegistry registry()
      This static method returns the current BiomeRegistry instance.
      Returns:
      the current BiomeRegistry instance.
      Since:
      2.3.0

    • buildDelegate

      @AsOf("2.3.0") Object buildDelegate(Biome biome)
      Builds a custom biome into a minecraft biome.
      Parameters:
      biome - the biome to build
      Returns:
      the built biome

    • register

      @AsOf("0.0.1") default void register(Biome... biomes)
      This method registers a custom biome to a Minecraft server.
      Parameters:
      biomes - The biomes that should be registered to the server.
      Since:
      0.0.1

    • register

      @AsOf("2.3.1") void register(Collection<Biome> biomes)
      Registers a collection of custom biomes to a Minecraft server.
      Parameters:
      biomes - The collection of Biome objects that should be registered to the server.
      Since:
      2.3.1

    • modify

      @AsOf("0.0.8") default void modify(Biome... biomes)
      This method modifies an existing biome on the Minecraft server. Another biome must already exist with the same ResourceKey. It takes a CustomBiome object as an argument.
      Parameters:
      biomes - The AbstractBiomes that should internally be used to modify the existing biome.
      Throws:
      IllegalArgumentException - if the biome does not already exist in the registry.
      Since:
      0.0.8

    • modify

      @AsOf("2.3.1") void modify(Collection<Biome> biomes)
      Modifies a collection of existing biomes on the Minecraft server.
      Parameters:
      biomes - The collection of AbstractBiomes that should internally be used to modify the existing biomes.
      Since:
      2.3.1

    • getBiome

      @AsOf("2.3.0") <T extends Biome> T getBiome(ResourceKey key)
      Gets an abstract biome from the registry.
      Type Parameters:
      T - the type of the biome
      Parameters:
      key - the key of the biome to get
      Returns:
      the abstract biome
      Since:
      2.3.0