ProtoFlux:Substring

Substring

Str

*

StartIndex

Length

Strings

The Substring node allows one to get an arbitrary portion of a provided string.

Inputs

Str (String)

The string to remove a segment from.

StartIndex (int)

The 0-indexed starting point of retrieval from Str.

Length (int)

Length of the output substring. If no node is connected to this input, the substring will continue until the end of the string.

Strings are UTF-16 encoded, and Length represents the amount of UTF16 codepoints in the output string. Usage of this node on a string containing characters outside the Basic Multilingual Plane may result in confusing behavior, such as the amount of characters in the output string being less than the Length value.

Outputs

* (String)

A segment of Str starting at StartIndex with length Length. If the segment goes past the end of Str, the output is truncated at the end of Str. If Length is less than 1, the output will be an Empty String.

Examples

• 
  Substring being used to tell what's inside of a string in a provided segment, as well as its relation to Get Character.