ProtoFlux:Get Character: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 20:27, 3 June 2024

Get Character

Str

*

Index

Characters

The Get Character node retrieves a character from a given string at a given index.

Inputs

Str (string)

The string to retrieve a character from.

Index (int)

The 0-indexed character to retrieve from Str.

Outputs

* (char)

The character from Str at index Index. If Index is either negative or greater than or equal to the length of Str, the output will be a character with value 0.

This node deals with individual chars of a string, whether by way of indexing a string or by returning a char. This may result in unintuitive behavior with strings containing characters that reside outside the Basic Multilingual Plane, such as "mismatched" indices or returning an invalid char. For more information, see the type page for String.

Examples

Get Character being used to retrieve a character from a string, as well as its relation to the Substring node.

@@ Line 13: / Line 13: @@
 |}}
-Get Character is a ProtoFlux node that retrieves an arbitrary character from a given string.
+The '''Get Character''' node retrieves a character from a given string at a given index.
 == Inputs ==
-=== Str ([[Type:String|String]]) ===
+=== Str ([[Type:string|string]]) ===
 The string to retrieve a character from.
-=== Index ([[Type:Int|int]]) ===
+=== Index ([[Type:int|int]]) ===
 The 0-indexed character to retrieve from <code>Str</code>.
 == Outputs ==
-=== * ([[Type:Char|char]]) ===
+=== * ([[Type:char|char]]) ===
-The character from <code>Str</code> at index <code>Index</code>. If <code>Index</code> is greater than or equal to the length of <code>Str</code>, or if <code>Str</code> is empty or null, the output will be a character with value <code>0</code>.
+The character from <code>Str</code> at index <code>Index</code>. If <code>Index</code> is either negative or greater than or equal to the [[ProtoFlux:String Length|length]] of <code>Str</code>, the output will be a character with value <code>0</code>.
-{{Template:Note|Strings are [[UTF-16]] encoded, and a char represents one UTF-16 code unit. 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 unwanted or confusing behavior, such as returning a surrogate.|warning}}
+{{Warning:String Outside BMP}}
 == Examples ==