Create Substring |
add warning about strings with chars outside bmp |
||
| (One intermediate revision by the same user not shown) | |||
| Line 14: | Line 14: | ||
|}} | |}} | ||
Substring is a ProtoFlux node that allows | Substring is a ProtoFlux node that allows one to get an arbitrary portion of a provided String. | ||
== Inputs == | == Inputs == | ||
| Line 24: | Line 24: | ||
=== StartIndex ([[Type:Int|int]]) === | === StartIndex ([[Type:Int|int]]) === | ||
The starting point of retrieval from Str | The 0-indexed starting point of retrieval from <code>Str</code>. | ||
=== Length ([[Type:Int|int]]) === | === Length ([[Type:Int|int]]) === | ||
Length of output substring. | |||
{{Template:Note|Strings are UTF-16 encoded, and <code>Length</code> represents the amount of UTF16 codepoints in the output string. Usage of this node on a string containing characters outside the [https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_Multilingual_Plane Basic Multilingual Plane] may result in confusing behavior, such as the amount of characters in the output string being less than the <code>Length</code> value.|warning}} | |||
== Outputs == | == Outputs == | ||
| Line 34: | Line 36: | ||
=== * ([[Type:String|String]]) === | === * ([[Type:String|String]]) === | ||
A segment of Str | A segment of <code>Str</code> starting at <code>StartIndex</code> with length <code>Length</code>. If the segment goes past the end of <code>Str</code>, the output is truncated at the end of <code>Str</code>. If <code>Length</code> is less than <code>1</code>, the output will be an [[ProtoFlux:Empty_String|Empty String]]. | ||
== Examples == | == Examples == | ||
<gallery widths=480px heights= | <gallery widths=480px heights=320px> | ||
File: | File:Protoflux_example_Get_Character_Substring.webp|alt=The substring node has String input "Cheese Mobile", Start Index 4, and Length 5. The output string is "se Mo".|Substring being used to tell what's inside of a string in a provided segment, as well as its relation to [[ProtoFlux:Get_Character|Get Character]]. | ||
</gallery> | </gallery> | ||
[[Category:ProtoFlux:Strings]] | [[Category:ProtoFlux:Strings]] | ||
Latest revision as of 03:34, 23 February 2024
Substring
Strings
Substring is a ProtoFlux node that 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 output substring.
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.
