===================
BiomeColorConverter
===================

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

Types
=====

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

---------

EXACT
-----

.. _object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-else:

:bdg-ref-primary:`else <object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-else>` :doc:`/config/documentation/objects/Biome` 

.. _object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-match:

:bdg-ref-primary:`match <object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-match>` :doc:`/config/documentation/objects/BiomeColorMapping` 

.. _object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-ignore-alpha:

:bdg-ref-success:`ignore-alpha <object-biomecolorconverter-template-biome-provider-image-v2-exact-parameter-ignore-alpha>` :doc:`/config/documentation/objects/Boolean` 

Default: ``true``

---------

CLOSEST
-------

.. _object-biomecolorconverter-template-biome-provider-image-v2-closest-parameter-match:

:bdg-ref-primary:`match <object-biomecolorconverter-template-biome-provider-image-v2-closest-parameter-match>` :doc:`/config/documentation/objects/BiomeColorMapping` 

Uses
====

This object is used in one place:

- :ref:`In IMAGE in BiomeProvider <object-biomeprovider-template-biome-provider-image-v2-image-parameter-color-conversion>`:

  :bdg-ref-primary:`color-conversion <object-biomeprovider-template-biome-provider-image-v2-image-parameter-color-conversion>` :doc:`/config/documentation/objects/BiomeColorConverter`