PipelineBiome#

*Config object requires the ‘biome-provider-pipeline-v2’ addon to use

A representation of a biome to be distributed across the biome pipeline.

Pipeline biomes may either represent:

  • Regular Biomes

  • Placeholder biomes

  • Replacement targets

Representing Regular Biomes#

If defined as an existing biome’s id, then the pipeline biome will simply represent the biome. The pipeline biome representing a regular biome will use all the regular biome’s tags.

Placeholder Biomes#

If a pipeline biome does not correspond to any regular biome id, it will be treated as a placeholder biome instead.

Placeholder biomes act as regular biomes being passed through the biome pipeline, but can be used as placeholder names representing anything you’d like. Conventionally placeholder biomes should be all lowercase to distinguish them from regular biome ids.

For example rather than distributing actual biomes within a Source, more general ‘land’ and ‘ocean’ placeholders can be used:

source:
  type: SAMPLER
  biomes:
    - land: 1
    - ocean: 1
  sampler:
    type: OPEN_SIMPLEX_2

For a pipeline to be valid, it must not be possible for a placeholder biome to be found in the final biome distribution. This means that any placeholder biomes introduced into the pipeline must eventually be replaced by pipeline biomes that represent real biomes.

A placeholder biome ending up in the final distribution is called a ‘pipeline leak’.

The above source by itself would not load unless both land and ocean are eventually replaced with pipeline biomes representing regular biomes.

Self Syntax#

Pipeline biomes being ‘replaced to’ may be defined as SELF, which acts as a placeholder for the pipeline biome being replaced. This is useful when you want to replace pipeline biomes containing a Tag with themselves in addition to other biomes.

Uses#

Used by 7 parameters: