godot-docs/classes/class_regexmatch.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RegExMatch.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RegExMatch:

RegExMatch
==========

**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_end<class_RegExMatch_get_end>`  **(** :ref:`Variant<class_variant>` name=0  **)** const       |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_group_count<class_RegExMatch_get_group_count>`  **(** **)** const                             |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>`  | :ref:`get_names<class_RegExMatch_get_names>`  **(** **)** const                                         |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`get_start<class_RegExMatch_get_start>`  **(** :ref:`Variant<class_variant>` name=0  **)** const   |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`          | :ref:`get_string<class_RegExMatch_get_string>`  **(** :ref:`Variant<class_variant>` name=0  **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>`            | :ref:`get_strings<class_RegExMatch_get_strings>`  **(** **)** const                                     |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`          | :ref:`get_subject<class_RegExMatch_get_subject>`  **(** **)** const                                     |
+--------------------------------------+---------------------------------------------------------------------------------------------------------+

Member Function Description
---------------------------

.. _class_RegExMatch_get_end:

- :ref:`int<class_int>`  **get_end**  **(** :ref:`Variant<class_variant>` name=0  **)** const

Returns the end position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).

.. _class_RegExMatch_get_group_count:

- :ref:`int<class_int>`  **get_group_count**  **(** **)** const

Returns the number of numeric capturing groups.

.. _class_RegExMatch_get_names:

- :ref:`Dictionary<class_dictionary>`  **get_names**  **(** **)** const

Returns an array of names of named capturing groups.

.. _class_RegExMatch_get_start:

- :ref:`int<class_int>`  **get_start**  **(** :ref:`Variant<class_variant>` name=0  **)** const

Returns the starting position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).

.. _class_RegExMatch_get_string:

- :ref:`String<class_string>`  **get_string**  **(** :ref:`Variant<class_variant>` name=0  **)** const

Returns the result of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).

.. _class_RegExMatch_get_strings:

- :ref:`Array<class_array>`  **get_strings**  **(** **)** const

.. _class_RegExMatch_get_subject:

- :ref:`String<class_string>`  **get_subject**  **(** **)** const