======
Source
======

:superscript:`*Config object requires the 'biome-provider-pipeline-v2' addon to use`

A pipeline source

Types
=====

Different types of ``Source`` provide different behaviours and may have additional parameters for configuring that behavior.

The type is specified by setting the :bdg-primary:`type` parameter to the name of the type. If the same name is used by two different addons, you can prefix the name with ``ADDON_NAME:`` to specify which one to use.

A list of available types for ``Source`` are listed below:

---------

SAMPLER
-------

Distributes a :ref:`weighted list <weighted-list>` of pipeline biomes according to a :doc:`/config/documentation/objects/NoiseSampler`\.


.. _object-source-template-biome-provider-pipeline-v2-sampler-parameter-biomes:

:bdg-ref-primary:`biomes <object-source-template-biome-provider-pipeline-v2-sampler-parameter-biomes>` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> 

.. _object-source-template-biome-provider-pipeline-v2-sampler-parameter-sampler:

:bdg-ref-primary:`sampler <object-source-template-biome-provider-pipeline-v2-sampler-parameter-sampler>` :doc:`/config/documentation/objects/NoiseSampler` 

---------

IMAGE
-----

:superscript:`*Type requires the 'pipeline-image' addon to use`

.. _object-source-template-pipeline-image-image-parameter-color-conversion:

:bdg-ref-primary:`color-conversion <object-source-template-pipeline-image-image-parameter-color-conversion>` :doc:`/config/documentation/objects/PipelineBiomeColorConverter` 

.. _object-source-template-pipeline-image-image-parameter-color-sampler:

:bdg-ref-primary:`color-sampler <object-source-template-pipeline-image-image-parameter-color-sampler>` :doc:`/config/documentation/objects/ColorSampler` 

Uses
====

This object is used in one place:

- :ref:`In PIPELINE in BiomeProvider <object-biomeprovider-template-biome-provider-pipeline-v2-pipeline-parameter-pipeline.source>`:

  :bdg-ref-primary:`pipeline.source <object-biomeprovider-template-biome-provider-pipeline-v2-pipeline-parameter-pipeline.source>` :doc:`/config/documentation/objects/Source` - The initial biome layout.