======= Locator ======= When defined in a :doc:`/config/documentation/configs/FEATURE` config, distributors determine what Y levels a structure can be placed at. Locators iterate through each block within a column of blocks in the world (typically within a constrained Y level range defined by the specific locator), and return either *true* or *false* if structures should generate at that position or not. Types ===== Different types of ``Locator`` provide different behaviours and may have additional parameters for configuring that behavior. The type is specified by setting the :bdg-primary:`type` parameter to the name of the type. If the same name is used by two different addons, you can prefix the name with ``ADDON_NAME:`` to specify which one to use. A list of available types for ``Locator`` are listed below: --------- SURFACE ------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-surface-parameter-range: :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` --------- TOP --- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-top-parameter-range: :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` --------- RANDOM ------ :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-random-parameter-amount: :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` .. _object-locator-template-config-locators-random-parameter-height: :bdg-ref-primary:`height ` :doc:`/config/documentation/objects/Range` .. _object-locator-template-config-locators-random-parameter-salt: :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` Default: ``0`` --------- GAUSSIAN_RANDOM --------------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-gaussian_random-parameter-amount: :bdg-ref-primary:`amount ` :doc:`/config/documentation/objects/Range` .. _object-locator-template-config-locators-gaussian_random-parameter-height: :bdg-ref-primary:`height ` :doc:`/config/documentation/objects/Range` .. _object-locator-template-config-locators-gaussian_random-parameter-standard-deviation: :bdg-ref-primary:`standard-deviation ` :doc:`/config/documentation/objects/Float` .. _object-locator-template-config-locators-gaussian_random-parameter-salt: :bdg-ref-success:`salt ` :doc:`/config/documentation/objects/Integer` Default: ``0`` --------- PATTERN ------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-pattern-parameter-pattern: :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` .. _object-locator-template-config-locators-pattern-parameter-range: :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` --------- ADJACENT_PATTERN ---------------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-adjacent_pattern-parameter-pattern: :bdg-ref-primary:`pattern ` :doc:`/config/documentation/objects/Pattern` .. _object-locator-template-config-locators-adjacent_pattern-parameter-range: :bdg-ref-primary:`range ` :doc:`/config/documentation/objects/Range` .. _object-locator-template-config-locators-adjacent_pattern-parameter-match-all: :bdg-ref-success:`match-all ` :doc:`/config/documentation/objects/Boolean` Default: ``false`` --------- SAMPLER ------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-sampler-parameter-samplers: :bdg-ref-primary:`samplers ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/NoiseSampler`\> --------- SAMPLER_3D ---------- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-sampler_3d-parameter-sampler: :bdg-ref-primary:`sampler ` :doc:`/config/documentation/objects/NoiseSampler` --------- AND --- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-and-parameter-locators: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> --------- OR -- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-or-parameter-locators: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> --------- XOR --- :superscript:`*Type requires the 'config-locators' addon to use` .. _object-locator-template-config-locators-xor-parameter-locators: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> Uses ==== Used by 4 parameters: - :ref:`In OR in Locator `: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\> - :ref:`In AND in Locator `: :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` - :ref:`In XOR in Locator `: :bdg-ref-primary:`locators ` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Locator`\>