===========
Distributor
===========

When defined in a :doc:`/config/documentation/configs/FEATURE` config, distributors determine which columns in the world
structures can be placed in.

Distributors operate in 2D. For each set of 2D coordinates, a distributor will return either *true* or *false*,
where true means a structure may generate within that column.


Types
=====

Different types of ``Distributor`` 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 ``Distributor`` are listed below:

---------

SAMPLER
-------

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-sampler-parameter-sampler:

:bdg-ref-primary:`sampler <object-distributor-template-config-distributors-sampler-parameter-sampler>` :doc:`/config/documentation/objects/NoiseSampler` 

.. _object-distributor-template-config-distributors-sampler-parameter-threshold:

:bdg-ref-success:`threshold <object-distributor-template-config-distributors-sampler-parameter-threshold>` :doc:`/config/documentation/objects/Float` 

Default: ``0.0``

---------

POINTS
------

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-points-parameter-points:

:bdg-ref-primary:`points <object-distributor-template-config-distributors-points-parameter-points>` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Point`\> 

---------

PADDED_GRID
-----------

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-padded_grid-parameter-padding:

:bdg-ref-primary:`padding <object-distributor-template-config-distributors-padded_grid-parameter-padding>` :doc:`/config/documentation/objects/Integer` 

.. _object-distributor-template-config-distributors-padded_grid-parameter-salt:

:bdg-ref-primary:`salt <object-distributor-template-config-distributors-padded_grid-parameter-salt>` :doc:`/config/documentation/objects/Integer` 

.. _object-distributor-template-config-distributors-padded_grid-parameter-width:

:bdg-ref-primary:`width <object-distributor-template-config-distributors-padded_grid-parameter-width>` :doc:`/config/documentation/objects/Integer` 

---------

AND
---

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-and-parameter-distributors:

:bdg-ref-primary:`distributors <object-distributor-template-config-distributors-and-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> 

---------

OR
--

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-or-parameter-distributors:

:bdg-ref-primary:`distributors <object-distributor-template-config-distributors-or-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> 

---------

XOR
---

:superscript:`*Type requires the 'config-distributors' addon to use`

.. _object-distributor-template-config-distributors-xor-parameter-distributors:

:bdg-ref-primary:`distributors <object-distributor-template-config-distributors-xor-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> 

---------

YES
---

:superscript:`*Type requires the 'config-distributors' addon to use`

---------

NO
--

:superscript:`*Type requires the 'config-distributors' addon to use`

Uses
====

Used by 4 parameters:

- :ref:`In base in FEATURE <config-feature-template-config-feature-base-parameter-distributor>`:

  :bdg-ref-primary:`distributor <config-feature-template-config-feature-base-parameter-distributor>` :doc:`/config/documentation/objects/Distributor` 

- :ref:`In XOR in Distributor <object-distributor-template-config-distributors-xor-parameter-distributors>`:

  :bdg-ref-primary:`distributors <object-distributor-template-config-distributors-xor-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> 

- :ref:`In OR in Distributor <object-distributor-template-config-distributors-or-parameter-distributors>`:

  :bdg-ref-primary:`distributors <object-distributor-template-config-distributors-or-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> 

- :ref:`In AND in Distributor <object-distributor-template-config-distributors-and-parameter-distributors>`:

  :bdg-ref-primary:`distributors <object-distributor-template-config-distributors-and-parameter-distributors>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\>