# Substring

## Overview

![The Substring Node.](/files/1YCHczdYYFCIonYAwrKG)

The **Substring Node** returns a part of a **String** based on the specified parameters given by the user.

For example, if the given **String** were `Lorem Ipsum` and the start index were `6` and the length of the *substring* were `5`, the output would be `Ipsum`.

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

## Attributes

![The Substring Node Attributes.](/files/KedeMFJUAU9dA8k2F4la)

| Attribute     | Type       | Description                                                                                                                                 |
| ------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `Source`      | **String** | The original **String** that the *substring* will come from, if one is not provided in the **Input Socket**.                                |
| `Start index` | **Int**    | The place in the **String** where the *substring* should start, if one is not provided in the **Input Socket**. The first index is 0.       |
| `Length`      | **Int**    | The length of the desired *substring*, if one is not provided in the **Input Socket**. This will decide the end of the *substring* as well. |

## Inputs

| Input             | Type       | Description                                                                                 |
| ----------------- | ---------- | ------------------------------------------------------------------------------------------- |
| *Pulse Input* (►) | **Pulse**  | A standard **Input Pulse**, to trigger the execution of the **Node**.                       |
| `Source`          | **String** | The original **String** that the *substring* will come from.                                |
| `Start index`     | **Int**    | The place in the **String** where the *substring* should start. The first index is 0.       |
| `Length`          | **Int**    | The length of the desired *substring*. This will decide the end of the *substring* as well. |

## 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. |
| `Substring`        | **String** | The resulting *substring*.                                                                                                             |


---

# 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/substring.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.