From 5974e2e0a1c316d76c8963d2cd5eab2e8ea0f319 Mon Sep 17 00:00:00 2001 From: Astrashh Date: Sat, 6 Jan 2024 12:58:29 +0000 Subject: [PATCH] Build: (35e96bd) Elaborate on YAML nesting --- .../config/development/config-data.rst.txt | 139 +++++++---- .../objects/BiomeColorMapping.rst.txt | 8 +- .../objects/BiomeProvider.rst.txt | 8 +- .../documentation/objects/Block.rst.txt | 28 +-- .../documentation/objects/Boolean.rst.txt | 28 +-- .../objects/ColorSampler.rst.txt | 24 +- .../documentation/objects/ColorString.rst.txt | 8 +- .../DimensionApplicableSampler.rst.txt | 8 +- .../documentation/objects/Distributor.rst.txt | 16 +- .../documentation/objects/Float.rst.txt | 212 ++++++++-------- .../documentation/objects/Image.rst.txt | 8 +- .../documentation/objects/Integer.rst.txt | 172 ++++++------- .../config/documentation/objects/List.rst.txt | 76 +++--- .../documentation/objects/Locator.rst.txt | 14 +- .../config/documentation/objects/Map.rst.txt | 56 ++--- .../objects/MathFunction.rst.txt | 8 +- .../objects/NoiseSampler.rst.txt | 168 ++++++------- .../documentation/objects/Pattern.rst.txt | 24 +- .../objects/PipelineBiome.rst.txt | 18 +- .../documentation/objects/Range.rst.txt | 44 ++-- .../config/documentation/objects/Set.rst.txt | 16 +- .../documentation/objects/String.rst.txt | 100 ++++---- .../config/documentation/objects/Tag.rst.txt | 24 +- .../objects/WeightedList.rst.txt | 32 +-- api/intro/creating-simple-addon.html | 8 +- api/intro/development-environment.html | 44 ++-- config/development/config-data.html | 232 ++++++++++-------- config/development/config-system.html | 56 ++--- config/development/introduction.html | 8 +- .../development/pack-from-scratch/index.html | 12 +- .../objects/BiomeColorMapping.html | 6 +- .../documentation/objects/BiomeProvider.html | 6 +- config/documentation/objects/Block.html | 26 +- config/documentation/objects/Boolean.html | 26 +- .../documentation/objects/ColorSampler.html | 22 +- config/documentation/objects/ColorString.html | 6 +- .../objects/DimensionApplicableSampler.html | 6 +- config/documentation/objects/Distributor.html | 12 +- config/documentation/objects/Float.html | 198 +++++++-------- config/documentation/objects/Image.html | 6 +- config/documentation/objects/Integer.html | 164 ++++++------- config/documentation/objects/List.html | 68 ++--- config/documentation/objects/Locator.html | 10 +- config/documentation/objects/Map.html | 48 ++-- .../documentation/objects/MathFunction.html | 6 +- .../documentation/objects/NoiseSampler.html | 162 ++++++------ config/documentation/objects/Pattern.html | 18 +- .../documentation/objects/PipelineBiome.html | 12 +- config/documentation/objects/Range.html | 36 +-- config/documentation/objects/Set.html | 14 +- config/documentation/objects/String.html | 90 +++---- config/documentation/objects/Tag.html | 18 +- .../documentation/objects/WeightedList.html | 30 +-- searchindex.js | 2 +- 54 files changed, 1341 insertions(+), 1250 deletions(-) diff --git a/_sources/config/development/config-data.rst.txt b/_sources/config/development/config-data.rst.txt index 210bd0b..a41e539 100644 --- a/_sources/config/development/config-data.rst.txt +++ b/_sources/config/development/config-data.rst.txt @@ -357,38 +357,65 @@ Nesting Objects Because values in maps and items in lists can be of any type, It's possible to nest maps in maps, lists in lists, lists in maps, and so on. -Here is an example of a ``Map`` contained within the value of another -``Map`` (which is the top level object): +.. tip:: + + Defining something inside something else is commonly referred to as 'nesting'. .. tab-set:: .. tab-item:: YAML - .. admonition:: Info - :class: tip + When setting the value of a map, typically it will just fit on the + same line as the key, for example the ``Float`` 42 can just be written + in-line with the key, after the colon like so: + + .. code-block:: yaml - For simple data types like integers and strings it is clear which key - corresponds to which value, as they are typically contained on the same - line, but maps and lists may span multiple lines, so we need a way of - defining which objects are defined under which keys and items. In YAML, - we can specify this kind of relationship via *indentation* - which is - simply how many spaces come before the key one a line. We conventionally - use two spaces to indicate 'one level' of indentation in YAML configs. + key: 42 + + Types that can span multiple lines, such as maps and lists won't fit + on a single line. For example you man want the following map which spans + multiple lines to be a value within another map: .. code-block:: yaml - :caption: config.yml - :linenos: - parent-key: - child-key: value - sibling-key: another value + foo: a + bar: b + + To nest this map as a value of a key, say ``baz``, in another map, it can be + defined under the key with additional indentation like so: + + .. code-block:: yaml + + baz: + foo: a + bar: b + + Indentation / indenting text refers to having some consistent number of spaces before + each line in text. In YAML, the recommended number of spaces to indent is 2 as shown above. + + Lists can be nested similarly like so: + + .. code-block:: yaml + + my-list: + - item 1 + - item 2 - You can see that the map containing ``child-key`` and ``sibling-key`` is - indented by two spaces, and is defined under the ``parent-key`` key, - signifying that it belongs to that key. + Multiple 'levels of indentation' can be used, for example here is the prior map further + nested under (as the value for the key) ``qux``: + + .. code-block:: yaml + + qux: + baz: + foo: a + bar: b .. tab-item:: JSON + Example of a ``Map`` defined in a ``Map``: + .. code-block:: json :caption: config.json :linenos: @@ -400,36 +427,66 @@ Here is an example of a ``Map`` contained within the value of another } } -And here is a ``Map`` (the top level object) containing a ``List`` of -``String``\ s: - -.. tab-set:: - - .. tab-item:: YAML - - .. code-block:: yaml - :caption: config.yml - :linenos: - - list of strings: - - item 1 - - item 2 - - item 3 - - .. tab-item:: JSON + Example of a ``List`` defined in a ``Map``: .. code-block:: json :caption: config.json :linenos: - + { - "list of strings": [ - "item 1", - "item 2", - "item 3" + "my-list": [ + "item 1", + "item 2" ] } +Illegally defining two values for one key +----------------------------------------- + +A common mistake in YAML is to accidentally assign two different +values to the same key. + +For example the following is invalid: + +.. code-block:: yaml + + key: foo + baz: bar + +The reason this is invalid is because there are two competing values being +assigned to ``key``, which are ``foo`` and the map containing ``baz: bar``. + +Deleting one of the values would make this valid YAML: + +.. code-block:: yaml + + key: + baz: bar + +Or + +.. code-block:: yaml + + key: foo + +A config might end up in this invalid state for many reasons. + +A key may have been deleted or omitted which could be remedied by re-adding it like so: + +.. code-block:: yaml + + key: foo + missing: + baz: bar + +Indentation may have been changed by accident, for example removing indentation +would make it valid like so: + +.. code-block:: yaml + + key: foo + baz: bar + Combining Everything ==================== diff --git a/_sources/config/documentation/objects/BiomeColorMapping.rst.txt b/_sources/config/documentation/objects/BiomeColorMapping.rst.txt index b2860ae..cb3c9a8 100644 --- a/_sources/config/documentation/objects/BiomeColorMapping.rst.txt +++ b/_sources/config/documentation/objects/BiomeColorMapping.rst.txt @@ -34,10 +34,10 @@ Uses Used by 2 parameters: -- :ref:`In EXACT in BiomeColorConverter `: +- :ref:`In CLOSEST in BiomeColorConverter `: - :bdg-ref-primary:`match ` :doc:`/config/documentation/objects/BiomeColorMapping` + :bdg-ref-primary:`match ` :doc:`/config/documentation/objects/BiomeColorMapping` -- :ref:`In CLOSEST in BiomeColorConverter `: +- :ref:`In EXACT in BiomeColorConverter `: - :bdg-ref-primary:`match ` :doc:`/config/documentation/objects/BiomeColorMapping` \ No newline at end of file + :bdg-ref-primary:`match ` :doc:`/config/documentation/objects/BiomeColorMapping` \ No newline at end of file diff --git a/_sources/config/documentation/objects/BiomeProvider.rst.txt b/_sources/config/documentation/objects/BiomeProvider.rst.txt index 37c4ac9..15fa0b4 100644 --- a/_sources/config/documentation/objects/BiomeProvider.rst.txt +++ b/_sources/config/documentation/objects/BiomeProvider.rst.txt @@ -132,10 +132,10 @@ Uses Used by 2 parameters: -- :ref:`In base in pack.yml `: +- :ref:`In EXTRUSION in BiomeProvider `: - :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/BiomeProvider` - Determines where biomes should generate in the world. + :bdg-ref-primary:`provider ` :doc:`/config/documentation/objects/BiomeProvider` -- :ref:`In EXTRUSION in BiomeProvider `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`provider ` :doc:`/config/documentation/objects/BiomeProvider` \ No newline at end of file + :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/BiomeProvider` - Determines where biomes should generate in the world. \ No newline at end of file diff --git a/_sources/config/documentation/objects/Block.rst.txt b/_sources/config/documentation/objects/Block.rst.txt index a489e88..9b2be19 100644 --- a/_sources/config/documentation/objects/Block.rst.txt +++ b/_sources/config/documentation/objects/Block.rst.txt @@ -14,34 +14,34 @@ Uses Used by 8 parameters: -- :ref:`In base in ORE `: +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> - :ref:`In base in SCATTERED_ORE `: :bdg-ref-primary:`material ` :doc:`/config/documentation/objects/Block` -- :ref:`In MATCH in Pattern `: - - :bdg-ref-primary:`block ` :doc:`/config/documentation/objects/Block` - -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In base in ORE `: - :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> + :bdg-ref-primary:`material ` :doc:`/config/documentation/objects/Block` -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In MATCH_SET in Pattern `: - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> + :bdg-ref-primary:`blocks ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> - :ref:`In base in ORE `: :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> -- :ref:`In MATCH_SET in Pattern `: +- :ref:`In base in ORE `: - :bdg-ref-primary:`blocks ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> + :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> -- :ref:`In base in ORE `: +- :ref:`In MATCH in Pattern `: + + :bdg-ref-primary:`block ` :doc:`/config/documentation/objects/Block` + +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-primary:`material ` :doc:`/config/documentation/objects/Block` \ No newline at end of file + :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/Boolean.rst.txt b/_sources/config/documentation/objects/Boolean.rst.txt index 7b51577..9b04f35 100644 --- a/_sources/config/documentation/objects/Boolean.rst.txt +++ b/_sources/config/documentation/objects/Boolean.rst.txt @@ -12,46 +12,46 @@ Uses Used by 13 parameters: -- :ref:`In GABOR in NoiseSampler `: - - :bdg-ref-success:`isotropic ` :doc:`/config/documentation/objects/Boolean` - -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In CHANNEL in NoiseSampler `: - :bdg-ref-success:`physics ` :doc:`/config/documentation/objects/Boolean` + :bdg-ref-success:`normalize ` :doc:`/config/documentation/objects/Boolean` - If the channel should be normalized to range [-1, 1] or not. - :ref:`In STITCHED_BITMAP in Image `: :bdg-ref-success:`zero-indexed ` :doc:`/config/documentation/objects/Boolean` -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-success:`normalize ` :doc:`/config/documentation/objects/Boolean` - If set to true, the returned distance will be normalized to be within the range ``[-1, 1]``, otherwise the raw distance is returned. + :bdg-ref-success:`physics ` :doc:`/config/documentation/objects/Boolean` - :ref:`In CHANNEL in NoiseSampler `: :bdg-ref-success:`premultiply ` :doc:`/config/documentation/objects/Boolean` - Whether to multiply color channels by the alpha channel or not. -- :ref:`In base in ORE `: +- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: - :bdg-ref-success:`physics ` :doc:`/config/documentation/objects/Boolean` + :bdg-ref-success:`invert-threshold ` :doc:`/config/documentation/objects/Boolean` - :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: :bdg-ref-success:`clamp-to-max-edge ` :doc:`/config/documentation/objects/Boolean` -- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: +- :ref:`In base in ORE `: - :bdg-ref-success:`invert-threshold ` :doc:`/config/documentation/objects/Boolean` + :bdg-ref-success:`physics ` :doc:`/config/documentation/objects/Boolean` -- :ref:`In CHANNEL in NoiseSampler `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`normalize ` :doc:`/config/documentation/objects/Boolean` - If the channel should be normalized to range [-1, 1] or not. + :bdg-ref-success:`isotropic ` :doc:`/config/documentation/objects/Boolean` - :ref:`In BITMAP in Image `: :bdg-ref-success:`zero-indexed ` :doc:`/config/documentation/objects/Boolean` +- :ref:`In DISTANCE in NoiseSampler `: + + :bdg-ref-success:`normalize ` :doc:`/config/documentation/objects/Boolean` - If set to true, the returned distance will be normalized to be within the range ``[-1, 1]``, otherwise the raw distance is returned. + - :ref:`In ADJACENT_PATTERN in Locator `: :bdg-ref-success:`match-all ` :doc:`/config/documentation/objects/Boolean` diff --git a/_sources/config/documentation/objects/ColorSampler.rst.txt b/_sources/config/documentation/objects/ColorSampler.rst.txt index 2a588ad..9418d52 100644 --- a/_sources/config/documentation/objects/ColorSampler.rst.txt +++ b/_sources/config/documentation/objects/ColorSampler.rst.txt @@ -105,26 +105,26 @@ Uses Used by 6 parameters: -- :ref:`In SINGLE_IMAGE in ColorSampler `: - - :bdg-ref-primary:`outside-sampler ` :doc:`/config/documentation/objects/ColorSampler` - The sampler that provides colors for coordinates outside the bounds of the ``Image`` . - -- :ref:`In IMAGE in Source `: +- :ref:`In CHANNEL in NoiseSampler `: - :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` + :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` - The color sampler to extract channel values from. -- :ref:`In ROTATE in ColorSampler `: +- :ref:`In IMAGE in BiomeProvider `: - :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` + :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` - :ref:`In TRANSLATE in ColorSampler `: :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` -- :ref:`In IMAGE in BiomeProvider `: +- :ref:`In IMAGE in Source `: - :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` + :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` -- :ref:`In CHANNEL in NoiseSampler `: +- :ref:`In SINGLE_IMAGE in ColorSampler `: + + :bdg-ref-primary:`outside-sampler ` :doc:`/config/documentation/objects/ColorSampler` - The sampler that provides colors for coordinates outside the bounds of the ``Image`` . + +- :ref:`In ROTATE in ColorSampler `: - :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` - The color sampler to extract channel values from. \ No newline at end of file + :bdg-ref-primary:`color-sampler ` :doc:`/config/documentation/objects/ColorSampler` \ No newline at end of file diff --git a/_sources/config/documentation/objects/ColorString.rst.txt b/_sources/config/documentation/objects/ColorString.rst.txt index bfdf7ad..37b43e3 100644 --- a/_sources/config/documentation/objects/ColorString.rst.txt +++ b/_sources/config/documentation/objects/ColorString.rst.txt @@ -11,10 +11,10 @@ Uses Used by 2 parameters: -- :ref:`In MAP in BiomeColorMapping `: +- :ref:`In COLOR in ColorSampler `: - :bdg-ref-primary:`map ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/ColorString`\, :doc:`/config/documentation/objects/Biome`\> + :bdg-ref-primary:`color ` :doc:`/config/documentation/objects/ColorString` - The color to output. -- :ref:`In COLOR in ColorSampler `: +- :ref:`In MAP in BiomeColorMapping `: - :bdg-ref-primary:`color ` :doc:`/config/documentation/objects/ColorString` - The color to output. \ No newline at end of file + :bdg-ref-primary:`map ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/ColorString`\, :doc:`/config/documentation/objects/Biome`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/DimensionApplicableSampler.rst.txt b/_sources/config/documentation/objects/DimensionApplicableSampler.rst.txt index 8afe123..99c282a 100644 --- a/_sources/config/documentation/objects/DimensionApplicableSampler.rst.txt +++ b/_sources/config/documentation/objects/DimensionApplicableSampler.rst.txt @@ -17,14 +17,14 @@ Uses Used by 3 parameters: -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. - - :ref:`In base in pack.yml `: :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: + + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. + - :ref:`In EXPRESSION in NoiseSampler `: :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - Defines a mapping of function names to samplers. \ No newline at end of file diff --git a/_sources/config/documentation/objects/Distributor.rst.txt b/_sources/config/documentation/objects/Distributor.rst.txt index 966cf1a..b15f9b5 100644 --- a/_sources/config/documentation/objects/Distributor.rst.txt +++ b/_sources/config/documentation/objects/Distributor.rst.txt @@ -117,18 +117,18 @@ Uses Used by 4 parameters: -- :ref:`In base in FEATURE `: - - :bdg-ref-primary:`distributor ` :doc:`/config/documentation/objects/Distributor` - -- :ref:`In OR in Distributor `: +- :ref:`In AND in Distributor `: - :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> + :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> - :ref:`In XOR in Distributor `: :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> -- :ref:`In AND in Distributor `: +- :ref:`In base in FEATURE `: + + :bdg-ref-primary:`distributor ` :doc:`/config/documentation/objects/Distributor` + +- :ref:`In OR in Distributor `: - :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> \ No newline at end of file + :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/Float.rst.txt b/_sources/config/documentation/objects/Float.rst.txt index 7977cc4..1394eea 100644 --- a/_sources/config/documentation/objects/Float.rst.txt +++ b/_sources/config/documentation/objects/Float.rst.txt @@ -12,218 +12,218 @@ Uses Used by 54 parameters: -- :ref:`In PIPELINE in BiomeProvider `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`blend.amplitude ` :doc:`/config/documentation/objects/Float` - The blend strength. + :bdg-ref-success:`frequency_0 ` :doc:`/config/documentation/objects/Float` -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In PERLIN in NoiseSampler `: - :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In LINEAR in NoiseSampler `: +- :ref:`In SAMPLER in Distributor `: - :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`threshold ` :doc:`/config/documentation/objects/Float` -- :ref:`In VALUE in NoiseSampler `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In DOMAIN_WARP in NoiseSampler `: - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> + :bdg-ref-success:`amplitude ` :doc:`/config/documentation/objects/Float` - How much warping to apply. -- :ref:`In PERLIN in NoiseSampler `: +- :ref:`In FBM in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` -- :ref:`In GABOR in NoiseSampler `: +- :ref:`In OPEN_SIMPLEX_2 in NoiseSampler `: - :bdg-ref-success:`rotation ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In GAUSSIAN in NoiseSampler `: +- :ref:`In KERNEL in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` -- :ref:`In KERNEL in NoiseSampler `: +- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: - :bdg-ref-primary:`kernel ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Float`\>> + :bdg-ref-success:`scale ` :doc:`/config/documentation/objects/Float` - Scales the height of the heightmap. -- :ref:`In RIDGED in NoiseSampler `: +- :ref:`In CLAMP in NoiseSampler `: - :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Float` -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In CONSTANT in NoiseSampler `: - :bdg-ref-success:`point.y ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`value ` :doc:`/config/documentation/objects/Float` - The value to be outputted. -- :ref:`In DOMAIN_WARP in NoiseSampler `: +- :ref:`In LINEAR in NoiseSampler `: - :bdg-ref-success:`amplitude ` :doc:`/config/documentation/objects/Float` - How much warping to apply. + :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Float` -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In RIDGED in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`rotation ` :doc:`/config/documentation/objects/Float` -- :ref:`In KERNEL in NoiseSampler `: +- :ref:`In WHITE_NOISE in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In RIDGED in NoiseSampler `: +- :ref:`In NORMAL in NoiseSampler `: - :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`standard-deviation ` :doc:`/config/documentation/objects/Float` -- :ref:`In NORMAL in NoiseSampler `: +- :ref:`In POSITIVE_WHITE_NOISE in NoiseSampler `: - :bdg-ref-primary:`mean ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In FBM in NoiseSampler `: +- :ref:`In ROTATE in ColorSampler `: - :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`angle ` :doc:`/config/documentation/objects/Float` -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-success:`point.x ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> + +- :ref:`In CELLULAR in NoiseSampler `: + + :bdg-ref-success:`jitter ` :doc:`/config/documentation/objects/Float` - Determines how far cell origins can randomly spread out from the center of cells. - :ref:`In base in BIOME `: :bdg-ref-success:`terrain.blend.weight-2d ` :doc:`/config/documentation/objects/Float` -- :ref:`In OPEN_SIMPLEX_2 in NoiseSampler `: +- :ref:`In CELLULAR in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. - :ref:`In GABOR in NoiseSampler `: :bdg-ref-success:`deviation ` :doc:`/config/documentation/objects/Float` -- :ref:`In GAUSSIAN_RANDOM in Locator `: - - :bdg-ref-primary:`standard-deviation ` :doc:`/config/documentation/objects/Float` - -- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-primary:`base ` :doc:`/config/documentation/objects/Float` - The base y level of the terrain. + :bdg-ref-success:`weighted-strength ` :doc:`/config/documentation/objects/Float` -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In VALUE in NoiseSampler `: - :bdg-ref-success:`jitter ` :doc:`/config/documentation/objects/Float` - Determines how far cell origins can randomly spread out from the center of cells. + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In FBM in NoiseSampler `: +- :ref:`In DISTANCE in NoiseSampler `: - :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`point.y ` :doc:`/config/documentation/objects/Float` -- :ref:`In WHITE_NOISE in NoiseSampler `: +- :ref:`In DISTANCE in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`point.z ` :doc:`/config/documentation/objects/Float` -- :ref:`In CLAMP in NoiseSampler `: +- :ref:`In NORMAL in NoiseSampler `: - :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`mean ` :doc:`/config/documentation/objects/Float` -- :ref:`In KERNEL in NoiseSampler `: +- :ref:`In base in ORE `: - :bdg-ref-success:`factor ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`size ` :doc:`/config/documentation/objects/Float` -- :ref:`In IMAGE in NoiseSampler `: +- :ref:`In PIPELINE in BiomeProvider `: - :bdg-ref-primary:`frequency ` :doc:`/config/documentation/objects/Float` - :ref:`Frequency ` of the image. Determines how the image gets scaled. + :bdg-ref-success:`blend.amplitude ` :doc:`/config/documentation/objects/Float` - The blend strength. -- :ref:`In SIMPLEX in NoiseSampler `: +- :ref:`In DISTANCE in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`point.x ` :doc:`/config/documentation/objects/Float` -- :ref:`In base in ORE `: +- :ref:`In GAUSSIAN in NoiseSampler `: - :bdg-ref-primary:`size ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In POSITIVE_WHITE_NOISE in NoiseSampler `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` -- :ref:`In GABOR in NoiseSampler `: +- :ref:`In CLAMP in NoiseSampler `: - :bdg-ref-success:`frequency_0 ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Float` -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In KERNEL in NoiseSampler `: - :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`factor ` :doc:`/config/documentation/objects/Float` -- :ref:`In GABOR in NoiseSampler `: +- :ref:`In base in BIOME `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`terrain.blend.weight ` :doc:`/config/documentation/objects/Float` -- :ref:`In LINEAR in NoiseSampler `: +- :ref:`In DISTANCE in NoiseSampler `: - :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`radius ` :doc:`/config/documentation/objects/Float` - The radius from the configured point corresponding to an output of ``1``. -- :ref:`In CONSTANT in NoiseSampler `: +- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: - :bdg-ref-success:`value ` :doc:`/config/documentation/objects/Float` - The value to be outputted. + :bdg-ref-primary:`base ` :doc:`/config/documentation/objects/Float` - The base y level of the terrain. -- :ref:`In OPEN_SIMPLEX_2S in NoiseSampler `: +- :ref:`In FBM in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` -- :ref:`In VALUE_CUBIC in NoiseSampler `: +- :ref:`In RIDGED in NoiseSampler `: - :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. + :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In FBM in NoiseSampler `: - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. + :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` -- :ref:`In CLAMP in NoiseSampler `: +- :ref:`In GAUSSIAN_RANDOM in Locator `: - :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`standard-deviation ` :doc:`/config/documentation/objects/Float` -- :ref:`In ROTATE in ColorSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-primary:`angle ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In SCALE in NoiseSampler `: - :bdg-ref-success:`point.z ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`amplitude ` :doc:`/config/documentation/objects/Float` -- :ref:`In FBM in NoiseSampler `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`impulses ` :doc:`/config/documentation/objects/Float` -- :ref:`In SAMPLER in Distributor `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-success:`threshold ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` -- :ref:`In base in BIOME `: +- :ref:`In VALUE_CUBIC in NoiseSampler `: - :bdg-ref-success:`terrain.blend.weight ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In RIDGED in NoiseSampler `: +- :ref:`In SIMPLEX in NoiseSampler `: - :bdg-ref-success:`lacunarity ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In SCALE in NoiseSampler `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-primary:`amplitude ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`ping-pong ` :doc:`/config/documentation/objects/Float` -- :ref:`In GABOR in NoiseSampler `: +- :ref:`In OPEN_SIMPLEX_2S in NoiseSampler `: - :bdg-ref-success:`impulses ` :doc:`/config/documentation/objects/Float` + :bdg-ref-success:`frequency ` :doc:`/config/documentation/objects/Float` - Controls the :ref:`frequency ` of noise. -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In LINEAR in NoiseSampler `: - :bdg-ref-success:`radius ` :doc:`/config/documentation/objects/Float` - The radius from the configured point corresponding to an output of ``1``. + :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Float` -- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: +- :ref:`In IMAGE in NoiseSampler `: - :bdg-ref-success:`scale ` :doc:`/config/documentation/objects/Float` - Scales the height of the heightmap. + :bdg-ref-primary:`frequency ` :doc:`/config/documentation/objects/Float` - :ref:`Frequency ` of the image. Determines how the image gets scaled. -- :ref:`In NORMAL in NoiseSampler `: +- :ref:`In KERNEL in NoiseSampler `: - :bdg-ref-primary:`standard-deviation ` :doc:`/config/documentation/objects/Float` + :bdg-ref-primary:`kernel ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Float`\>> -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In RIDGED in NoiseSampler `: - :bdg-ref-success:`ping-pong ` :doc:`/config/documentation/objects/Float` \ No newline at end of file + :bdg-ref-success:`gain ` :doc:`/config/documentation/objects/Float` \ No newline at end of file diff --git a/_sources/config/documentation/objects/Image.rst.txt b/_sources/config/documentation/objects/Image.rst.txt index d6798c5..ac0880a 100644 --- a/_sources/config/documentation/objects/Image.rst.txt +++ b/_sources/config/documentation/objects/Image.rst.txt @@ -108,10 +108,10 @@ Used by 3 parameters: :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/Image` -- :ref:`In TILED_IMAGE in ColorSampler `: +- :ref:`In SINGLE_IMAGE in ColorSampler `: - :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/Image` - The image to be sampled + :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/Image` - The image to be sampled -- :ref:`In SINGLE_IMAGE in ColorSampler `: +- :ref:`In TILED_IMAGE in ColorSampler `: - :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/Image` - The image to be sampled \ No newline at end of file + :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/Image` - The image to be sampled \ No newline at end of file diff --git a/_sources/config/documentation/objects/Integer.rst.txt b/_sources/config/documentation/objects/Integer.rst.txt index d8a674d..aeb1a75 100644 --- a/_sources/config/documentation/objects/Integer.rst.txt +++ b/_sources/config/documentation/objects/Integer.rst.txt @@ -12,178 +12,178 @@ Uses Used by 44 parameters: -- :ref:`In map in Range `: +- :ref:`In GAUSSIAN in NoiseSampler `: - :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Integer` - The maximum value (exclusive) of the range. + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + +- :ref:`In base in BIOME `: + + :bdg-ref-success:`terrain.blend.step ` :doc:`/config/documentation/objects/Integer` + +- :ref:`In PADDED_GRID in Distributor `: + + :bdg-ref-primary:`salt ` :doc:`/config/documentation/objects/Integer` - :ref:`In STITCHED_BITMAP in Image `: :bdg-ref-primary:`columns ` :doc:`/config/documentation/objects/Integer` - How many columns of images to stitch together. -- :ref:`In GABOR in NoiseSampler `: +- :ref:`In PADDED_GRID in Distributor `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-primary:`padding ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in pack.yml `: +- :ref:`In SIMPLEX in NoiseSampler `: - :bdg-ref-success:`carving.resolution.vertical ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In FEATURE in GenerationStage `: +- :ref:`In POSTERIZATION in NoiseSampler `: - :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`steps ` :doc:`/config/documentation/objects/Integer` -- :ref:`In PADDED_GRID in Distributor `: +- :ref:`In EXTRUSION in BiomeProvider `: - :bdg-ref-primary:`width ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in BIOME `: +- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: - :bdg-ref-success:`terrain.blend.distance ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`threshold ` :doc:`/config/documentation/objects/Integer` -- :ref:`In OPEN_SIMPLEX_2S in NoiseSampler `: +- :ref:`In GABOR in NoiseSampler `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In VALUE_CUBIC in NoiseSampler `: +- :ref:`In base in BIOME `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-success:`terrain.blend.distance ` :doc:`/config/documentation/objects/Integer` -- :ref:`In POSTERIZATION in NoiseSampler `: +- :ref:`In POSITIVE_WHITE_NOISE in NoiseSampler `: - :bdg-ref-primary:`steps ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In base in BIOME `: +- :ref:`In TRANSLATE in ColorSampler `: - :bdg-ref-success:`slant-depth ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`z ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in BIOME `: +- :ref:`In map in Range `: - :bdg-ref-success:`ocean.level ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`max ` :doc:`/config/documentation/objects/Integer` - The maximum value (exclusive) of the range. -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In VALUE in NoiseSampler `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In NORMAL in NoiseSampler `: +- :ref:`In FBM in NoiseSampler `: - :bdg-ref-success:`groups ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` -- :ref:`In POSITIVE_WHITE_NOISE in NoiseSampler `: +- :ref:`In FEATURE in GenerationStage `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` -- :ref:`In STITCHED_BITMAP in Image `: +- :ref:`In base in BIOME `: - :bdg-ref-primary:`rows ` :doc:`/config/documentation/objects/Integer` - How many rows of images to stitch together. + :bdg-ref-success:`ocean.level ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in BIOME `: +- :ref:`In VALUE_CUBIC in NoiseSampler `: - :bdg-ref-success:`terrain.blend.step ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In PADDED_GRID in Distributor `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`padding ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`blend.terrain.elevation ` :doc:`/config/documentation/objects/Integer` -- :ref:`In RANDOM in Locator `: +- :ref:`In PERLIN in NoiseSampler `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In FBM in NoiseSampler `: +- :ref:`In OPEN_SIMPLEX_2S in NoiseSampler `: - :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In EXTRUSION in BiomeProvider `: +- :ref:`In base in BIOME `: - :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`palette ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Palette`\, :doc:`/config/documentation/objects/Integer`\>> -- :ref:`In BITMAP in Image `: +- :ref:`In TRANSLATE in ColorSampler `: - :bdg-ref-primary:`rows ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`x ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-success:`size ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` -- :ref:`In VALUE in NoiseSampler `: +- :ref:`In GAUSSIAN_RANDOM in Locator `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` -- :ref:`In BITMAP in Image `: +- :ref:`In PIPELINE in BiomeProvider `: - :bdg-ref-primary:`columns ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` - A performance parameter that determines the size of each biome 'pixel' in blocks. -- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-success:`threshold ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`size ` :doc:`/config/documentation/objects/Integer` -- :ref:`In IMAGE in BiomeProvider `: +- :ref:`In base in BIOME `: - :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`color ` :doc:`/config/documentation/objects/Integer` -- :ref:`In SIMPLEX in NoiseSampler `: +- :ref:`In BITMAP in Image `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-primary:`rows ` :doc:`/config/documentation/objects/Integer` -- :ref:`In PADDED_GRID in Distributor `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`salt ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`carving.resolution.horizontal ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in pack.yml `: +- :ref:`In NORMAL in NoiseSampler `: - :bdg-ref-success:`blend.terrain.elevation ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`groups ` :doc:`/config/documentation/objects/Integer` - :ref:`In WHITE_NOISE in NoiseSampler `: :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In TRANSLATE in ColorSampler `: +- :ref:`In IMAGE in BiomeProvider `: - :bdg-ref-primary:`z ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` - :ref:`In OPEN_SIMPLEX_2 in NoiseSampler `: :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In PERLIN in NoiseSampler `: - - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. - -- :ref:`In RIDGED in NoiseSampler `: - - :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` - -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In CELLULAR in NoiseSampler `: - :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. -- :ref:`In base in pack.yml `: +- :ref:`In RANDOM in Locator `: - :bdg-ref-success:`carving.resolution.horizontal ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in BIOME `: +- :ref:`In PADDED_GRID in Distributor `: - :bdg-ref-primary:`palette ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Palette`\, :doc:`/config/documentation/objects/Integer`\>> + :bdg-ref-primary:`width ` :doc:`/config/documentation/objects/Integer` -- :ref:`In GAUSSIAN_RANDOM in Locator `: +- :ref:`In map in Range `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Integer` - The minimum value (inclusive) of the range. -- :ref:`In TRANSLATE in ColorSampler `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`x ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`carving.resolution.vertical ` :doc:`/config/documentation/objects/Integer` -- :ref:`In base in BIOME `: +- :ref:`In base in BIOME `: - :bdg-ref-primary:`color ` :doc:`/config/documentation/objects/Integer` + :bdg-ref-success:`slant-depth ` :doc:`/config/documentation/objects/Integer` -- :ref:`In map in Range `: +- :ref:`In RIDGED in NoiseSampler `: - :bdg-ref-primary:`min ` :doc:`/config/documentation/objects/Integer` - The minimum value (inclusive) of the range. + :bdg-ref-success:`octaves ` :doc:`/config/documentation/objects/Integer` -- :ref:`In GAUSSIAN in NoiseSampler `: +- :ref:`In BITMAP in Image `: - :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` - Determines the :ref:`seed ` for the sampler. + :bdg-ref-primary:`columns ` :doc:`/config/documentation/objects/Integer` -- :ref:`In PIPELINE in BiomeProvider `: +- :ref:`In STITCHED_BITMAP in Image `: - :bdg-ref-success:`resolution ` :doc:`/config/documentation/objects/Integer` - A performance parameter that determines the size of each biome 'pixel' in blocks. \ No newline at end of file + :bdg-ref-primary:`rows ` :doc:`/config/documentation/objects/Integer` - How many rows of images to stitch together. \ No newline at end of file diff --git a/_sources/config/documentation/objects/List.rst.txt b/_sources/config/documentation/objects/List.rst.txt index 934cd91..ce21c8e 100644 --- a/_sources/config/documentation/objects/List.rst.txt +++ b/_sources/config/documentation/objects/List.rst.txt @@ -12,70 +12,54 @@ Uses Used by 19 parameters: -- :ref:`In AND in Locator `: - - :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> - -- :ref:`In base in PALETTE `: +- :ref:`In OR in Locator `: - :bdg-ref-primary:`layers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/PaletteLayer`\> + :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> -- :ref:`In KERNEL in NoiseSampler `: +- :ref:`In PIPELINE in BiomeProvider `: - :bdg-ref-primary:`kernel ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Float`\>> + :bdg-ref-primary:`pipeline.stages ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Stage`\> - A list of stages that are successively applied. -- :ref:`In SAMPLER in Locator `: +- :ref:`In CUBIC_SPLINE in NoiseSampler `: - :bdg-ref-primary:`samplers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/NoiseSampler`\> + :bdg-ref-primary:`points ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/CubicSplinePoint`\> - :ref:`In OR in Distributor `: :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> -- :ref:`In XOR in Distributor `: - - :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> - -- :ref:`In AND in Pattern `: - - :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> - -- :ref:`In AND in Distributor `: +- :ref:`In SAMPLER in Locator `: - :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> + :bdg-ref-primary:`samplers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/NoiseSampler`\> -- :ref:`In base in BIOME `: +- :ref:`In XOR in Pattern `: - :bdg-ref-primary:`features.\ ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Feature`\> + :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> -- :ref:`In PIPELINE in BiomeProvider `: +- :ref:`In AND in Locator `: - :bdg-ref-primary:`pipeline.stages ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Stage`\> - A list of stages that are successively applied. + :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> -- :ref:`In EXTRUSION in BiomeProvider `: +- :ref:`In base in PALETTE `: - :bdg-ref-primary:`extrusions ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Extrusion`\> + :bdg-ref-primary:`layers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/PaletteLayer`\> -- :ref:`In XOR in Pattern `: +- :ref:`In XOR in Locator `: - :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> + :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> -- :ref:`In CUBIC_SPLINE in NoiseSampler `: +- :ref:`In AND in Distributor `: - :bdg-ref-primary:`points ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/CubicSplinePoint`\> + :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> -- :ref:`In OR in Locator `: +- :ref:`In base in BIOME `: - :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> + :bdg-ref-success:`slant ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/SlantLayer`\> - :ref:`In base in BIOME `: :bdg-ref-primary:`palette ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Palette`\, :doc:`/config/documentation/objects/Integer`\>> -- :ref:`In base in BIOME `: - - :bdg-ref-success:`slant ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/SlantLayer`\> - - :ref:`In OR in Pattern `: :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> @@ -84,6 +68,22 @@ Used by 19 parameters: :bdg-ref-primary:`stages ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/GenerationStage`\> - A list of generation stages. -- :ref:`In XOR in Locator `: +- :ref:`In base in BIOME `: + + :bdg-ref-primary:`features.\ ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Feature`\> + +- :ref:`In AND in Pattern `: + + :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> + +- :ref:`In XOR in Distributor `: + + :bdg-ref-primary:`distributors ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Distributor`\> + +- :ref:`In KERNEL in NoiseSampler `: + + :bdg-ref-primary:`kernel ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Float`\>> + +- :ref:`In EXTRUSION in BiomeProvider `: - :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> \ No newline at end of file + :bdg-ref-primary:`extrusions ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Extrusion`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/Locator.rst.txt b/_sources/config/documentation/objects/Locator.rst.txt index a7c732e..84741d5 100644 --- a/_sources/config/documentation/objects/Locator.rst.txt +++ b/_sources/config/documentation/objects/Locator.rst.txt @@ -183,18 +183,18 @@ Uses Used by 4 parameters: -- :ref:`In AND in Locator `: - - :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> - - :ref:`In OR in Locator `: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> -- :ref:`In base in FEATURE `: +- :ref:`In AND in Locator `: - :bdg-ref-primary:`locator ` :doc:`/config/documentation/objects/Locator` + :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> - :ref:`In XOR in Locator `: - :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> \ No newline at end of file + :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> + +- :ref:`In base in FEATURE `: + + :bdg-ref-primary:`locator ` :doc:`/config/documentation/objects/Locator` \ No newline at end of file diff --git a/_sources/config/documentation/objects/Map.rst.txt b/_sources/config/documentation/objects/Map.rst.txt index 2d4b222..993f67d 100644 --- a/_sources/config/documentation/objects/Map.rst.txt +++ b/_sources/config/documentation/objects/Map.rst.txt @@ -12,58 +12,58 @@ Uses Used by 14 parameters: -- :ref:`In base in ORE `: +- :ref:`In base in pack.yml `: - :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. -- :ref:`In base in pack.yml `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In base in BIOME `: - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> + :bdg-ref-primary:`palette ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Palette`\, :doc:`/config/documentation/objects/Integer`\>> -- :ref:`In BORDER_LIST in Stage `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In REPLACE_LIST in Stage `: - :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In BORDER_LIST in Stage `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In MAP in BiomeColorMapping `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - Defines a mapping of function names to samplers. + :bdg-ref-primary:`map ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/ColorString`\, :doc:`/config/documentation/objects/Biome`\> -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - Defines a mapping of function names to samplers. -- :ref:`In MAP in BiomeColorMapping `: +- :ref:`In base in ORE `: - :bdg-ref-primary:`map ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/ColorString`\, :doc:`/config/documentation/objects/Biome`\> + :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> -- :ref:`In REPLACE_LIST in Stage `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. -- :ref:`In base in pack.yml `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> -- :ref:`In base in BIOME `: +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-primary:`palette ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Palette`\, :doc:`/config/documentation/objects/Integer`\>> \ No newline at end of file + :bdg-ref-success:`material-overrides ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/Block`\, :doc:`/config/documentation/objects/Block`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/MathFunction.rst.txt b/_sources/config/documentation/objects/MathFunction.rst.txt index 58b33b8..f2342b3 100644 --- a/_sources/config/documentation/objects/MathFunction.rst.txt +++ b/_sources/config/documentation/objects/MathFunction.rst.txt @@ -27,14 +27,14 @@ Uses Used by 3 parameters: -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. - - :ref:`In base in pack.yml `: :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: + + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. + - :ref:`In EXPRESSION in NoiseSampler `: :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/NoiseSampler.rst.txt b/_sources/config/documentation/objects/NoiseSampler.rst.txt index dd816a0..496202a 100644 --- a/_sources/config/documentation/objects/NoiseSampler.rst.txt +++ b/_sources/config/documentation/objects/NoiseSampler.rst.txt @@ -1469,182 +1469,182 @@ Uses Used by 45 parameters: -- :ref:`In PIPELINE in BiomeProvider `: +- :ref:`In SET in Extrusion `: - :bdg-ref-success:`blend.sampler ` :doc:`/config/documentation/objects/NoiseSampler` - A sampler that blends the pixelated effect produced by higher resolutions. + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In ADD in NoiseSampler `: +- :ref:`In SUB in NoiseSampler `: - :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SAMPLER_3D in Locator `: +- :ref:`In CELLULAR in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-success:`lookup ` :doc:`/config/documentation/objects/NoiseSampler` - The lookup sampler used when the ``distance`` parameter is set to ``NoiseLookup`` - :ref:`In PROBABILITY in NoiseSampler `: :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In MUL in NoiseSampler `: +- :ref:`In FRACTAL_EXPAND in Stage `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - Used to randomly determine which pipeline biome should be chosen. -- :ref:`In DOMAIN_WARP in NoiseSampler `: +- :ref:`In DIV in NoiseSampler `: - :bdg-ref-primary:`warp ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler that determines warping. + :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In MAX in NoiseSampler `: +- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: + + :bdg-ref-success:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler to be used as a heightmap. + +- :ref:`In REPLACE in Extrusion `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - :ref:`In SAMPLER in Locator `: :bdg-ref-primary:`samplers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/NoiseSampler`\> -- :ref:`In KERNEL in NoiseSampler `: +- :ref:`In base in BIOME `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`terrain.sampler-2d ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In POSTERIZATION in NoiseSampler `: +- :ref:`In SCALE in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In BORDER_LIST in Stage `: +- :ref:`In SAMPLER in Distributor `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In RIDGED in NoiseSampler `: +- :ref:`In DOMAIN_WARP in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`warp ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler that determines warping. -- :ref:`In MUL in NoiseSampler `: +- :ref:`In base in FEATURE `: - :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`structures.distribution ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In NORMAL in NoiseSampler `: +- :ref:`In CLAMP in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In REPLACE_LIST in Stage `: +- :ref:`In MUL in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In base in PALETTE `: +- :ref:`In SMOOTH in Stage `: - :bdg-ref-success:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - Used to randomly determine which pipeline biome should be chosen. -- :ref:`In MIN in NoiseSampler `: +- :ref:`In REPLACE in Stage `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. -- :ref:`In SUB in NoiseSampler `: +- :ref:`In BORDER in Stage `: - :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. -- :ref:`In SMOOTH in Stage `: +- :ref:`In SAMPLER in Source `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - Used to randomly determine which pipeline biome should be chosen. + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - :ref:`In MIN in NoiseSampler `: :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In CUBIC_SPLINE in NoiseSampler `: +- :ref:`In MIN in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SAMPLER in Distributor `: +- :ref:`In NORMAL in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - :ref:`In base in BIOME `: :bdg-ref-primary:`terrain.sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In REPLACE in Stage `: - - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. - -- :ref:`In REPLACE in Extrusion `: +- :ref:`In ADD in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In MUL in NoiseSampler `: - :bdg-ref-success:`lookup ` :doc:`/config/documentation/objects/NoiseSampler` - The lookup sampler used when the ``distance`` parameter is set to ``NoiseLookup`` + :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SUB in NoiseSampler `: +- :ref:`In REPLACE_LIST in Stage `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. -- :ref:`In FBM in NoiseSampler `: +- :ref:`In KERNEL in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In PING_PONG in NoiseSampler `: +- :ref:`In POSTERIZATION in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SAMPLER in Source `: +- :ref:`In SUB in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SCALE in NoiseSampler `: +- :ref:`In FBM in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In DIV in NoiseSampler `: +- :ref:`In ADD in NoiseSampler `: - :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In FRACTAL_EXPAND in Stage `: +- :ref:`In LINEAR in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - Used to randomly determine which pipeline biome should be chosen. + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In BORDER in Stage `: +- :ref:`In MAX in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. + :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In LINEAR_HEIGHTMAP in NoiseSampler `: +- :ref:`In DIV in NoiseSampler `: - :bdg-ref-success:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler to be used as a heightmap. + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In CLAMP in NoiseSampler `: +- :ref:`In CUBIC_SPLINE in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In DIV in NoiseSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In DOMAIN_WARP in NoiseSampler `: +- :ref:`In PIPELINE in BiomeProvider `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler to be warped. + :bdg-ref-success:`blend.sampler ` :doc:`/config/documentation/objects/NoiseSampler` - A sampler that blends the pixelated effect produced by higher resolutions. -- :ref:`In MAX in NoiseSampler `: +- :ref:`In PING_PONG in NoiseSampler `: - :bdg-ref-primary:`left ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In ADD in NoiseSampler `: +- :ref:`In RIDGED in NoiseSampler `: - :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In SET in Extrusion `: +- :ref:`In SAMPLER_3D in Locator `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In base in PALETTE `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-success:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` -- :ref:`In base in BIOME `: +- :ref:`In BORDER_LIST in Stage `: - :bdg-ref-primary:`terrain.sampler-2d ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The noise sampler used to distribute pipeline biomes. -- :ref:`In LINEAR in NoiseSampler `: +- :ref:`In DOMAIN_WARP in NoiseSampler `: - :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` + :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` - The sampler to be warped. -- :ref:`In base in FEATURE `: +- :ref:`In MAX in NoiseSampler `: - :bdg-ref-primary:`structures.distribution ` :doc:`/config/documentation/objects/NoiseSampler` \ No newline at end of file + :bdg-ref-primary:`right ` :doc:`/config/documentation/objects/NoiseSampler` \ No newline at end of file diff --git a/_sources/config/documentation/objects/Pattern.rst.txt b/_sources/config/documentation/objects/Pattern.rst.txt index cd1124e..7df4e62 100644 --- a/_sources/config/documentation/objects/Pattern.rst.txt +++ b/_sources/config/documentation/objects/Pattern.rst.txt @@ -98,26 +98,26 @@ Uses Used by 6 parameters: -- :ref:`In OR in Pattern `: +- :ref:`In AND in Pattern `: - :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> + :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> -- :ref:`In NOT in Pattern `: +- :ref:`In XOR in Pattern `: - :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` + :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> -- :ref:`In PATTERN in Locator `: +- :ref:`In ADJACENT_PATTERN in Locator `: - :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` + :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` -- :ref:`In XOR in Pattern `: +- :ref:`In OR in Pattern `: - :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> + :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> -- :ref:`In AND in Pattern `: +- :ref:`In NOT in Pattern `: - :bdg-ref-primary:`patterns ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> + :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` -- :ref:`In ADJACENT_PATTERN in Locator `: +- :ref:`In PATTERN in Locator `: - :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` \ No newline at end of file + :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` \ No newline at end of file diff --git a/_sources/config/documentation/objects/PipelineBiome.rst.txt b/_sources/config/documentation/objects/PipelineBiome.rst.txt index 1c42855..350c60c 100644 --- a/_sources/config/documentation/objects/PipelineBiome.rst.txt +++ b/_sources/config/documentation/objects/PipelineBiome.rst.txt @@ -63,18 +63,22 @@ Uses Used by 7 parameters: -- :ref:`In SAMPLER in Source `: - - :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - - :ref:`In REPLACE_LIST in Stage `: :bdg-ref-primary:`default-to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The list of pipeline biomes to replace any matches of the default tag with. +- :ref:`In SAMPLER in Source `: + + :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> + - :ref:`In BORDER_LIST in Stage `: :bdg-ref-primary:`default-to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The default list of pipeline biomes to replace pipeline biomes containing the default replace tag with. +- :ref:`In REPLACE in Stage `: + + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The pipeline biomes that the ``from`` tag will be replaced with. + - :ref:`In REPLACE_LIST in Stage `: :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. @@ -85,8 +89,4 @@ Used by 7 parameters: - :ref:`In BORDER_LIST in Stage `: - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. - -- :ref:`In REPLACE in Stage `: - - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The pipeline biomes that the ``from`` tag will be replaced with. \ No newline at end of file + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. \ No newline at end of file diff --git a/_sources/config/documentation/objects/Range.rst.txt b/_sources/config/documentation/objects/Range.rst.txt index 004292b..2d16d31 100644 --- a/_sources/config/documentation/objects/Range.rst.txt +++ b/_sources/config/documentation/objects/Range.rst.txt @@ -42,25 +42,29 @@ Uses Used by 14 parameters: -- :ref:`In RANDOM in Locator `: +- :ref:`In MATCH_SET in Pattern `: - :bdg-ref-primary:`height ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` -- :ref:`In REPLACE in Extrusion `: +- :ref:`In RANDOM in Locator `: - :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`height ` :doc:`/config/documentation/objects/Range` - :ref:`In MATCH_AIR in Pattern `: :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` -- :ref:`In MATCH in Pattern `: +- :ref:`In MATCH_SOLID in Pattern `: - :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` -- :ref:`In PATTERN in Locator `: +- :ref:`In TOP in Locator `: - :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` + +- :ref:`In RANDOM in Locator `: + + :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` - :ref:`In SET in Extrusion `: @@ -70,30 +74,26 @@ Used by 14 parameters: :bdg-ref-primary:`height ` :doc:`/config/documentation/objects/Range` -- :ref:`In TOP in Locator `: +- :ref:`In MATCH in Pattern `: - :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` - :ref:`In ADJACENT_PATTERN in Locator `: :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` -- :ref:`In SURFACE in Locator `: - - :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` - -- :ref:`In MATCH_SET in Pattern `: +- :ref:`In PATTERN in Locator `: - :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` -- :ref:`In RANDOM in Locator `: +- :ref:`In SURFACE in Locator `: - :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` -- :ref:`In MATCH_SOLID in Pattern `: +- :ref:`In GAUSSIAN_RANDOM in Locator `: - :bdg-ref-primary:`offset ` :doc:`/config/documentation/objects/Range` + :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` -- :ref:`In GAUSSIAN_RANDOM in Locator `: +- :ref:`In REPLACE in Extrusion `: - :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` \ No newline at end of file + :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` \ No newline at end of file diff --git a/_sources/config/documentation/objects/Set.rst.txt b/_sources/config/documentation/objects/Set.rst.txt index dc29fd0..6dc1491 100644 --- a/_sources/config/documentation/objects/Set.rst.txt +++ b/_sources/config/documentation/objects/Set.rst.txt @@ -11,22 +11,22 @@ Uses Used by 5 parameters: -- :ref:`In MATCH_SET in Pattern `: +- :ref:`In POINTS in Distributor `: - :bdg-ref-primary:`blocks ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> + :bdg-ref-primary:`points ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Point`\> - :ref:`In base in SCATTERED_ORE `: :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> -- :ref:`In base in ORE `: - - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> - - :ref:`In base in BIOME `: :bdg-ref-primary:`tags ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Tag`\> -- :ref:`In POINTS in Distributor `: +- :ref:`In base in ORE `: + + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> + +- :ref:`In MATCH_SET in Pattern `: - :bdg-ref-primary:`points ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Point`\> \ No newline at end of file + :bdg-ref-primary:`blocks ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> \ No newline at end of file diff --git a/_sources/config/documentation/objects/String.rst.txt b/_sources/config/documentation/objects/String.rst.txt index 3ff627b..bfef7c0 100644 --- a/_sources/config/documentation/objects/String.rst.txt +++ b/_sources/config/documentation/objects/String.rst.txt @@ -12,102 +12,102 @@ Uses Used by 25 parameters: -- :ref:`In EXPRESSION in NoiseSampler `: - - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - -- :ref:`In base in PALETTE `: - - :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` - -- :ref:`In base in ORE `: - - :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` - -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In CELLULAR in NoiseSampler `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. + :bdg-ref-success:`distance ` :doc:`/config/documentation/objects/String` - The method used for calculating the distance from the cell origin. - :ref:`In IMAGE in NoiseSampler `: :bdg-ref-primary:`image ` :doc:`/config/documentation/objects/String` - Path to the image relative to the config pack directory. (For Windows users: Use the ``/`` directory separator instead of ``\``) -- :ref:`In IMAGE in NoiseSampler `: +- :ref:`In base in PALETTE `: - :bdg-ref-primary:`channel ` :doc:`/config/documentation/objects/String` - Which channel of the image to output. + :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` -- :ref:`In base in pack.yml `: +- :ref:`In FEATURE in GenerationStage `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. + :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> -- :ref:`In EXPRESSION in NoiseSampler `: +- :ref:`In base in SCATTERED_ORE `: - :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - Defines a mapping of function names to samplers. + :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` -- :ref:`In DISTANCE in NoiseSampler `: +- :ref:`In CELLULAR in NoiseSampler `: - :bdg-ref-success:`distance-function ` :doc:`/config/documentation/objects/String` - The function used to calculate distance between sample positions and the configured point. + :bdg-ref-success:`return ` :doc:`/config/documentation/objects/String` - The function the sampler will use to calculate the noise. -- :ref:`In base in pack.yml `: +- :ref:`In REPLACE in Extrusion `: - :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` - The id used to identify the config pack. + :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/String` -- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-success:`cost-function ` :doc:`/config/documentation/objects/String` + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. -- :ref:`In REPLACE in Extrusion `: +- :ref:`In base in pack.yml `: - :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/String` + :bdg-ref-success:`author ` :doc:`/config/documentation/objects/String` - Who developed the config pack. -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: - :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - An additional mappping of named noise samplers that can be used in the ``expression``. -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In base in ORE `: - :bdg-ref-success:`distance ` :doc:`/config/documentation/objects/String` - The method used for calculating the distance from the cell origin. + :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` -- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: +- :ref:`In IMAGE in NoiseSampler `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - An additional mappping of named math functions that can be used in the ``expression``. + :bdg-ref-primary:`channel ` :doc:`/config/documentation/objects/String` - Which channel of the image to output. + +- :ref:`In STITCHED_BITMAP in Image `: + + :bdg-ref-primary:`path ` :doc:`/config/documentation/objects/String` - The format string for the path to the images relative to the config pack directory. (For Windows users: Use the ``/`` directory separator instead of ``\``) - :ref:`In BITMAP in Image `: :bdg-ref-primary:`path-format ` :doc:`/config/documentation/objects/String` - Path to the image relative to the config pack directory. (For Windows users: Use the ``/`` directory separator instead of ``\``) -- :ref:`In base in pack.yml `: +- :ref:`In base in pack.yml `: - :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - A set of samplers globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. -- :ref:`In FEATURE in GenerationStage `: +- :ref:`In EXPRESSION in NoiseSampler `: - :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` + :bdg-ref-success:`samplers ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/DimensionApplicableSampler`\> - Defines a mapping of function names to samplers. + +- :ref:`In EXPRESSION_NORMALIZER in NoiseSampler `: + + :bdg-ref-success:`variables ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/Float`\> - An additional mapping of named constant variables that can be used by the ``expression``. - :ref:`In base in FEATURE `: :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` -- :ref:`In STITCHED_BITMAP in Image `: +- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: - :bdg-ref-primary:`path ` :doc:`/config/documentation/objects/String` - The format string for the path to the images relative to the config pack directory. (For Windows users: Use the ``/`` directory separator instead of ``\``) + :bdg-ref-success:`normalization ` :doc:`/config/documentation/objects/String` -- :ref:`In base in pack.yml `: +- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: - :bdg-ref-success:`author ` :doc:`/config/documentation/objects/String` - Who developed the config pack. + :bdg-ref-success:`cost-function ` :doc:`/config/documentation/objects/String` -- :ref:`In CELLULAR in NoiseSampler `: +- :ref:`In base in pack.yml `: - :bdg-ref-success:`return ` :doc:`/config/documentation/objects/String` - The function the sampler will use to calculate the noise. + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> - A set of math functions globally accessible within :doc:`/config/documentation/objects/Expression`\s in ``EXPRESSION`` samplers defined inside other config files. -- :ref:`In DISTANCE_TRANSFORM in NoiseSampler `: +- :ref:`In base in pack.yml `: - :bdg-ref-success:`normalization ` :doc:`/config/documentation/objects/String` + :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` - The id used to identify the config pack. -- :ref:`In base in SCATTERED_ORE `: +- :ref:`In EXPRESSION in NoiseSampler `: + + :bdg-ref-success:`functions ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/String`\, :doc:`/config/documentation/objects/MathFunction`\> + +- :ref:`In DISTANCE in NoiseSampler `: - :bdg-ref-primary:`id ` :doc:`/config/documentation/objects/String` \ No newline at end of file + :bdg-ref-success:`distance-function ` :doc:`/config/documentation/objects/String` - The function used to calculate distance between sample positions and the configured point. \ No newline at end of file diff --git a/_sources/config/documentation/objects/Tag.rst.txt b/_sources/config/documentation/objects/Tag.rst.txt index f569abb..ed6ae47 100644 --- a/_sources/config/documentation/objects/Tag.rst.txt +++ b/_sources/config/documentation/objects/Tag.rst.txt @@ -17,30 +17,30 @@ Uses Used by 7 parameters: -- :ref:`In REPLACE_LIST in Stage `: +- :ref:`In BORDER in Stage `: - :bdg-ref-primary:`default-from ` :doc:`/config/documentation/objects/Tag` - The default tag a pipeline biome must contain to be replaced. + :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/Tag` - The tag bordering pipeline biomes must contain for a pipeline biome to be replaced. -- :ref:`In BORDER in Stage `: +- :ref:`In REPLACE in Stage `: - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Tag` - The tag a pipeline biome must contain in order to be replaced. + :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/Tag` - Pipeline biomes containing this tag will be replaced. - :ref:`In BORDER_LIST in Stage `: :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/Tag` - The tag bordering pipeline biomes must contain for a pipeline biome to be replaced. -- :ref:`In BORDER in Stage `: +- :ref:`In BORDER_LIST in Stage `: - :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/Tag` - The tag bordering pipeline biomes must contain for a pipeline biome to be replaced. + :bdg-ref-primary:`default-replace ` :doc:`/config/documentation/objects/Tag` - The default tag a pipeline biome must contain in order to be replaced. -- :ref:`In REPLACE in Stage `: +- :ref:`In base in BIOME `: - :bdg-ref-primary:`from ` :doc:`/config/documentation/objects/Tag` - Pipeline biomes containing this tag will be replaced. + :bdg-ref-primary:`tags ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Tag`\> -- :ref:`In BORDER_LIST in Stage `: +- :ref:`In REPLACE_LIST in Stage `: - :bdg-ref-primary:`default-replace ` :doc:`/config/documentation/objects/Tag` - The default tag a pipeline biome must contain in order to be replaced. + :bdg-ref-primary:`default-from ` :doc:`/config/documentation/objects/Tag` - The default tag a pipeline biome must contain to be replaced. -- :ref:`In base in BIOME `: +- :ref:`In BORDER in Stage `: - :bdg-ref-primary:`tags ` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Tag`\> \ No newline at end of file + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Tag` - The tag a pipeline biome must contain in order to be replaced. \ No newline at end of file diff --git a/_sources/config/documentation/objects/WeightedList.rst.txt b/_sources/config/documentation/objects/WeightedList.rst.txt index f5cb462..d79eae4 100644 --- a/_sources/config/documentation/objects/WeightedList.rst.txt +++ b/_sources/config/documentation/objects/WeightedList.rst.txt @@ -12,42 +12,42 @@ Uses Used by 10 parameters: -- :ref:`In REPLACE in Extrusion `: - - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/ExtrusionReplaceableBiome`\> - - :ref:`In REPLACE_LIST in Stage `: :bdg-ref-primary:`default-to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The list of pipeline biomes to replace any matches of the default tag with. -- :ref:`In BORDER_LIST in Stage `: +- :ref:`In base in FEATURE `: - :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. + :bdg-ref-primary:`structures.structures ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/Structure`\> -- :ref:`In SET in Extrusion `: +- :ref:`In SAMPLER in Source `: - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/ExtrusionReplaceableBiome`\> + :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - :ref:`In BORDER_LIST in Stage `: :bdg-ref-primary:`default-to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The default list of pipeline biomes to replace pipeline biomes containing the default replace tag with. +- :ref:`In REPLACE in Stage `: + + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The pipeline biomes that the ``from`` tag will be replaced with. + - :ref:`In REPLACE_LIST in Stage `: :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. -- :ref:`In SAMPLER in Source `: +- :ref:`In BORDER in Stage `: - :bdg-ref-primary:`biomes ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The list of pipeline biomes to replace with. -- :ref:`In base in FEATURE `: +- :ref:`In BORDER_LIST in Stage `: - :bdg-ref-primary:`structures.structures ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/Structure`\> + :bdg-ref-primary:`replace ` :doc:`/config/documentation/objects/Map`\<:doc:`/config/documentation/objects/PipelineBiome`\, :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\>> - An additional set of mappings from pipeline biomes to weighted lists of pipeline biomes. -- :ref:`In REPLACE in Stage `: +- :ref:`In SET in Extrusion `: - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The pipeline biomes that the ``from`` tag will be replaced with. + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/ExtrusionReplaceableBiome`\> -- :ref:`In BORDER in Stage `: +- :ref:`In REPLACE in Extrusion `: - :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/PipelineBiome`\> - The list of pipeline biomes to replace with. \ No newline at end of file + :bdg-ref-primary:`to ` :doc:`/config/documentation/objects/WeightedList`\<:doc:`/config/documentation/objects/ExtrusionReplaceableBiome`\> \ No newline at end of file diff --git a/api/intro/creating-simple-addon.html b/api/intro/creating-simple-addon.html index 77f4dd8..59642a4 100644 --- a/api/intro/creating-simple-addon.html +++ b/api/intro/creating-simple-addon.html @@ -449,13 +449,13 @@

Compiling and Installing your Addon - -

Repository ConfigurationCodeMC Maven Repository. Configure your build system to fetch from it:

- -