Interface Biome

All Superinterfaces:
Keyed, Wrapper
All Known Subinterfaces:
CustomBiome
All Known Implementing Classes:
BiomeImpl, CustomBiomeImpl
@NullMarked @AsOf("2.3.0") public interface Biome extends Keyed, Wrapper
Represents an abstract biome in Minecraft.
Since:
2.3.0

  • Method Details

    • resourceKey

      @AsOf("3.0.0") ResourceKey resourceKey()
      The key associated with this biome.
      Returns:
      the key of this biome.
      Since:
      3.0.0

    • climateSettings

      @AsOf("3.0.0") ClimateSettings climateSettings()
      Climate settings associated with this biome.
      Returns:
      the climate settings associated with this biome.
      Since:
      3.0.0

    • climateSettings

      @AsOf("3.0.0") void climateSettings(ClimateSettings climateSettings)
      Sets new climate settings for this biome.
      Parameters:
      climateSettings - the new climate settings to set for this biome.
      Since:
      3.0.0

    • specialEffects

      @AsOf("3.0.0") BiomeSpecialEffects specialEffects()
      Various biome-specific visuals as they appear in vanilla.
      Returns:
      the biome special effects associated with this biome.
      Since:
      3.0.0

    • specialEffects

      @AsOf("3.0.0") void specialEffects(BiomeSpecialEffects specialEffects)
      Sets new special effects for this biome.
      Parameters:
      specialEffects - the new special effects to set for this biome.
      Since:
      3.0.0

    • attributes

      @AsOf("1.1.0") EnvironmentAttributeMap attributes()
      A map of the environment attributes associated with this biome.
      Returns:
      an environment attribute map populated with the environment attributes of this biome.
      Since:
      1.1.0

    • attributes

      @AsOf("2.2.0") void attributes(EnvironmentAttributeMap attributes)
      Sets the environment attributes for this biome.
      Parameters:
      attributes - the environment attribute map to set for this biome
      Since:
      2.2.0

    • biomeSpawner

      @AsOf("2.3.0") @Nullable BiomeSpawner biomeSpawner()
      Gets the biome spawner associated with this biome.
      Returns:
      the BiomeSpawner of this biome, or null if none is set.
      Since:
      2.3.0

    • biomeSpawner

      @AsOf("2.3.0") void biomeSpawner(@Nullable BiomeSpawner biomeSpawner)
      Sets or removes the BiomeSpawner of this biome.
      Parameters:
      biomeSpawner - the BiomeSpawner to set for this biome, or null to remove it.
      Since:
      2.3.0

    • generationSettings

      @AsOf("2.3.0") @Nullable BiomeGenerationSettings generationSettings()
      Gets world generation settings associated with this biome.
      Returns:
      the BiomeGenerationSettings of this biome, or null if none is set.
      Since:
      2.3.0

    • generationSettings

      @AsOf("2.3.0") void generationSettings(@Nullable BiomeGenerationSettings generationSettings)
      Sets or removes the world generation settings for this biome.
      Parameters:
      generationSettings - the BiomeGenerationSettings to set for this biome, or null to remove it.
      Since:
      2.3.0

    • isSimilar

      @AsOf("0.0.17") boolean isSimilar(Biome otherBiome)
      Compares this biome to another biome to determine if they are similar. Two AbstractBiomes are considered similar if they have the same properties.
      Parameters:
      otherBiome - The other AbstractBiome to compare to.
      Returns:
      true if the AbstractBiomes are similar, false otherwise.
      Since:
      0.0.17

    • bukkitBiome

      @AsOf("0.0.6") Biome bukkitBiome()
      Gets the Bukkit representation of this biome.
      Returns:
      the Bukkit Biome equivalent of this biome.
      Since:
      0.0.6

    • register

      @AsOf("3.0.0") default Biome register()
      Registers this biome in the biome registry.
      Returns:
      the registered biome
      Since:
      3.0.0

    • modify

      @AsOf("0.0.17") default Biome modify()
      Modifies the existing biome in the biome registry with the properties of this CustomBiome.
      Throws:
      IllegalArgumentException - if the biome is not registered.
      Since:
      0.0.17

    • toBuilder

      @AsOf("3.0.0") default Biome.Builder toBuilder()
      Converts this back into a builder.
      Returns:
      a builder with the same properties as this biome.
      Since:
      3.0.0

    • reference

      @AsOf("3.0.0") static Biome reference(ResourceKey resourceKey)
      Gets a reference to a biome from the biome registry.
      Parameters:
      resourceKey - the ResourceKey of the biome to get a reference to
      Returns:
      a reference to the biome with the given ResourceKey
      Since:
      3.0.0

    • builder

      @AsOf("2.3.0") static Biome.Builder builder()
      A new builder for this class.
      Returns:
      a new, empty Biome.Builder.
      Since:
      2.3.0

    • builder

      @AsOf("2.3.0") static Biome.Builder builder(ResourceKey resourceKey)
      Parameters:
      resourceKey - the ResourceKey to seed the builder with
      Returns:
      a new Biome.Builder seeded with the given resource key.
      Since:
      2.3.0