=======
Pattern
=======

:superscript:`*Config object requires the 'config-locators' addon to use`

Types
=====

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

---------

MATCH_AIR
---------

.. _object-pattern-template-config-locators-match_air-parameter-offset:

:bdg-ref-primary:`offset <object-pattern-template-config-locators-match_air-parameter-offset>` :doc:`/config/documentation/objects/Range` 

---------

MATCH_SOLID
-----------

.. _object-pattern-template-config-locators-match_solid-parameter-offset:

:bdg-ref-primary:`offset <object-pattern-template-config-locators-match_solid-parameter-offset>` :doc:`/config/documentation/objects/Range` 

---------

MATCH
-----

.. _object-pattern-template-config-locators-match-parameter-block:

:bdg-ref-primary:`block <object-pattern-template-config-locators-match-parameter-block>` :doc:`/config/documentation/objects/Block` 

.. _object-pattern-template-config-locators-match-parameter-offset:

:bdg-ref-primary:`offset <object-pattern-template-config-locators-match-parameter-offset>` :doc:`/config/documentation/objects/Range` 

---------

MATCH_SET
---------

.. _object-pattern-template-config-locators-match_set-parameter-blocks:

:bdg-ref-primary:`blocks <object-pattern-template-config-locators-match_set-parameter-blocks>` :doc:`/config/documentation/objects/Set`\<:doc:`/config/documentation/objects/Block`\> 

.. _object-pattern-template-config-locators-match_set-parameter-offset:

:bdg-ref-primary:`offset <object-pattern-template-config-locators-match_set-parameter-offset>` :doc:`/config/documentation/objects/Range` 

---------

AND
---

.. _object-pattern-template-config-locators-and-parameter-patterns:

:bdg-ref-primary:`patterns <object-pattern-template-config-locators-and-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> 

---------

OR
--

.. _object-pattern-template-config-locators-or-parameter-patterns:

:bdg-ref-primary:`patterns <object-pattern-template-config-locators-or-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> 

---------

XOR
---

.. _object-pattern-template-config-locators-xor-parameter-patterns:

:bdg-ref-primary:`patterns <object-pattern-template-config-locators-xor-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> 

---------

NOT
---

.. _object-pattern-template-config-locators-not-parameter-pattern:

:bdg-ref-primary:`pattern <object-pattern-template-config-locators-not-parameter-pattern>` :doc:`/config/documentation/objects/Pattern` 

Uses
====

Used by 6 parameters:

- :ref:`In OR in Pattern <object-pattern-template-config-locators-or-parameter-patterns>`:

  :bdg-ref-primary:`patterns <object-pattern-template-config-locators-or-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> 

- :ref:`In NOT in Pattern <object-pattern-template-config-locators-not-parameter-pattern>`:

  :bdg-ref-primary:`pattern <object-pattern-template-config-locators-not-parameter-pattern>` :doc:`/config/documentation/objects/Pattern` 

- :ref:`In XOR in Pattern <object-pattern-template-config-locators-xor-parameter-patterns>`:

  :bdg-ref-primary:`patterns <object-pattern-template-config-locators-xor-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\> 

- :ref:`In ADJACENT_PATTERN in Locator <object-locator-template-config-locators-adjacent_pattern-parameter-pattern>`:

  :bdg-ref-primary:`pattern <object-locator-template-config-locators-adjacent_pattern-parameter-pattern>` :doc:`/config/documentation/objects/Pattern` 

- :ref:`In PATTERN in Locator <object-locator-template-config-locators-pattern-parameter-pattern>`:

  :bdg-ref-primary:`pattern <object-locator-template-config-locators-pattern-parameter-pattern>` :doc:`/config/documentation/objects/Pattern` 

- :ref:`In AND in Pattern <object-pattern-template-config-locators-and-parameter-patterns>`:

  :bdg-ref-primary:`patterns <object-pattern-template-config-locators-and-parameter-patterns>` :doc:`/config/documentation/objects/List`\<:doc:`/config/documentation/objects/Pattern`\>