# MatchRegex

## Overview

![The MatchRegex Node.](/files/HoNT3cWUyarAVQ9FePIg)

The **MatchRegex** **Node** allows one to search a **String** for a certain pattern, which can be given as a *regular expression*. The part of the **String** in which the search is performed can be customized with the indices of the beginning and end of the search, which are given to the **Node** either as **Attributes** or **Inputs**. The **Node** outputs the result as a **Boolean**, together with the index of the first appearance of the searched pattern and the number of matches.

[**Scope**](/incari-studio/2023.1/toolbox/overview.md#scopes): **Project**, **Scene**, **Function**, **Prefab**.

## Attributes

![The MatchRegex Node Attributes.](/files/4lwDNxb1tm19uUTgVt5T)

### Inputs

| Attribute           | Type       | Description                                                                                                                     |
| ------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `String`            | **String** | The **String** in which the search will be performed, if none is given in the **Input Socket**.                                 |
| `Pattern`           | **String** | The pattern that will be searched for using regular expressions, if none is given in the `Regex` **Input Socket**.              |
| `From`              | **Int**    | The *index* of `String` from which the search will begin, if none is given in the **Input Socket**.                             |
| `To`                | **Int**    | The *index* of `String` until which the search will be performed, if none is given in the **Input Socket**.                     |
| `Count all matches` | **Bool**   | Whether all the matches of `Pattern` in `String` will be counted or not, if no **Bool** value is given in the **Input Socket**. |

## Inputs

| Input               | Type       | Description                                                            |
| ------------------- | ---------- | ---------------------------------------------------------------------- |
| *Pulse Input* (►)   | **Pulse**  | A standard **Input Pulse**, to trigger the execution of the **Node**.  |
| `String`            | **String** | The **String** in which the search will be performed.                  |
| `Regex`             | **String** | The pattern that will be searched for using regular expressions.       |
| `From`              | **Int**    | The *index* of `String` from which the search will begin.              |
| `To`                | **Int**    | The *index* of `String` until which the search will be performed.      |
| `Count all matches` | **Bool**   | Whether all the matches of `Regex` in `String` will be counted or not. |

## Outputs

| Output             | Type      | Description                                                                                                                            |
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Pulse Output* (►) | **Pulse** | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution. |
| `Found`            | **Bool**  | Whether `Regex` was found between the given indices of `String` or not.                                                                |
| `Position`         | **Int**   | The index of the first apparition of `Regex` in `String`.                                                                              |
| `Match count`      | **Int**   | The number of matches of `Regex` in the searched part of `String`. If `Count all matches` is set to *false*, the output is $$1$$.      |

## See Also

* [**ReplaceRegex**](/incari-studio/2023.1/toolbox/string/replaceregex.md)
* [**Contains**](/incari-studio/2023.1/toolbox/string/contains.md)

## External Links

* [*Regular expression*](https://en.wikipedia.org/wiki/Regular_expression) on Wikipedia.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.incari.com/incari-studio/2023.1/toolbox/string/match-regex.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.