Interface CustomBiome

All Superinterfaces:
Biome, Keyed, Wrapper
All Known Implementing Classes:
CustomBiomeImpl
@NullMarked @AsOf("3.0.0") public interface CustomBiome extends Biome
Represents a custom biome in Wyck. Extends Biome with client-side block replacements and friendly color accessors.
Since:
0.0.1

  • Method Details

    • blockReplacements

      @AsOf("3.0.0") List<BlockReplacement> blockReplacements()
      The block replacements of this custom biome.
      Returns:
      the block replacements of this custom biome.
      Since:
      0.0.6

    • blockReplacements

      @AsOf("3.0.0") CustomBiome blockReplacements(List<BlockReplacement> blockReplacements)
      Sets the block replacements of this custom biome.
      Parameters:
      blockReplacements - the block replacements to set for this custom biome
      Returns:
      this custom biome
      Since:
      0.0.6

    • waterColor

      @AsOf("3.0.0") default int waterColor()
      Returns:
      the water color of this custom biome.
      Since:
      3.0.0

    • foliageColor

      @AsOf("3.0.0") default @Nullable Integer foliageColor()
      Returns:
      the foliage color override of this custom biome, or null if unset.
      Since:
      3.0.0

    • dryFoliageColor

      @AsOf("3.0.0") default @Nullable Integer dryFoliageColor()
      Returns:
      the dry foliage color override of this custom biome, or null if unset.
      Since:
      3.0.0

    • grassColor

      @AsOf("3.0.0") default @Nullable Integer grassColor()
      Returns:
      the grass color override of this custom biome, or null if unset.
      Since:
      3.0.0

    • grassColorModifier

      @AsOf("3.0.0") default GrassColorModifier grassColorModifier()
      Returns:
      the grass color modifier of this custom biome.
      Since:
      3.0.0

    • fogColor

      @AsOf("3.0.0") default @Nullable Integer fogColor()
      Returns:
      the fog color of this custom biome, or null if unset.
      Since:
      3.0.0

    • waterFogColor

      @AsOf("3.0.0") default @Nullable Integer waterFogColor()
      Returns:
      the water fog color of this custom biome, or null if unset.
      Since:
      3.0.0

    • skyColor

      @AsOf("3.0.0") default @Nullable Integer skyColor()
      Returns:
      the sky color of this custom biome, or null if unset.
      Since:
      3.0.0

    • waterColor

      @AsOf("3.0.0") default CustomBiome waterColor(String waterColor)
      Sets the water color of this custom biome.
      Parameters:
      waterColor - the water color hex (e.g. "#3F75C4")
      Returns:
      this custom biome
      Since:
      3.0.0

    • foliageColor

      @AsOf("3.0.0") default CustomBiome foliageColor(@Nullable String foliageColor)
      Sets the foliage color override of this custom biome.
      Parameters:
      foliageColor - the foliage color hex, or null to clear the override
      Returns:
      this custom biome
      Since:
      3.0.0

    • dryFoliageColor

      @AsOf("3.0.0") default CustomBiome dryFoliageColor(@Nullable String dryFoliageColor)
      Sets the dry foliage color override of this custom biome.
      Parameters:
      dryFoliageColor - the dry foliage color hex, or null to clear the override
      Returns:
      this custom biome
      Since:
      3.0.0

    • grassColor

      @AsOf("3.0.0") default CustomBiome grassColor(@Nullable String grassColor)
      Sets the grass color override of this custom biome.
      Parameters:
      grassColor - the grass color hex, or null to clear the override
      Returns:
      this custom biome
      Since:
      3.0.0

    • grassColorModifier

      @AsOf("3.0.0") default CustomBiome grassColorModifier(GrassColorModifier grassColorModifier)
      Sets the grass color modifier of this custom biome.
      Parameters:
      grassColorModifier - the grass color modifier
      Returns:
      this custom biome
      Since:
      3.0.0

    • fogColor

      @AsOf("3.0.0") default CustomBiome fogColor(@Nullable String fogColor)
      Sets the fog color of this custom biome.
      Parameters:
      fogColor - the fog color hex, or null to clear it
      Returns:
      this custom biome
      Since:
      3.0.0

    • waterFogColor

      @AsOf("3.0.0") default CustomBiome waterFogColor(@Nullable String waterFogColor)
      Sets the water fog color of this custom biome.
      Parameters:
      waterFogColor - the water fog color hex, or null to clear it
      Returns:
      this custom biome
      Since:
      3.0.0

    • skyColor

      @AsOf("3.0.0") default CustomBiome skyColor(@Nullable String skyColor)
      Sets the sky color of this custom biome.
      Parameters:
      skyColor - the sky color hex, or null to clear it
      Returns:
      this custom biome
      Since:
      3.0.0

    • isSimilar

      @AsOf("0.0.17") boolean isSimilar(CustomBiome otherBiome)
      Compares this custom biome to another to determine if they are similar.
      Parameters:
      otherBiome - the other custom biome to compare to
      Returns:
      true if the custom biomes are similar, false otherwise.
      Since:
      0.0.17

    • register

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

    • modify

      @AsOf("3.0.0") default CustomBiome modify()
      Modifies this custom biome.
      Specified by:
      modify in interface Biome
      Returns:
      the modified custom biome
      Since:
      3.0.0

    • toBuilder

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

    • builder

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

    • builder

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

    • of

      @AsOf("3.0.0") static CustomBiome of(ResourceKey resourceKey)
      Creates a new custom biome with the given ResourceKey.
      Parameters:
      resourceKey - the ResourceKey of the custom biome to create
      Returns:
      a new custom biome with the given ResourceKey
      Since:
      3.0.0