Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
StringNameο
A built-in type for unique strings.
Descriptionο
StringNames are immutable strings designed for general-purpose representation of unique names (also called "string interning"). Two StringNames with the same value are the same object. Comparing them is extremely fast compared to regular Strings.
You will usually pass a String to methods expecting a StringName and it will be automatically converted (often at compile time), but in rare cases you can construct a StringName ahead of time with the StringName constructor or, in GDScript, the literal syntax &"example". Manually constructing a StringName allows you to control when the conversion from String occurs or to use the literal and prevent conversions entirely.
See also NodePath, which is a similar concept specifically designed to store pre-parsed scene tree paths.
All of String's methods are available in this class too. They convert the StringName into a string, and they also return a string. This is highly inefficient and should only be used if the string is desired.
Note: In C#, an explicit conversion to System.String is required to use the methods listed on this page. Use the ToString() method to cast a StringName to a string, and then use the equivalent methods in System.String or StringExtensions.
Note: In a boolean context, a StringName will evaluate to false if it is empty (StringName("")). Otherwise, a StringName will always evaluate to true.
Note
There are notable differences when using this API with C#. See C# API differences to GDScript for more information.
Constructorsο
StringName(from: StringName) |
|
StringName(from: String) |
Methodsο
Operatorsο
operator !=(right: String) |
|
operator !=(right: StringName) |
|
operator %(right: Variant) |
|
operator +(right: String) |
|
operator +(right: StringName) |
|
operator <(right: StringName) |
|
operator <=(right: StringName) |
|
operator ==(right: String) |
|
operator ==(right: StringName) |
|
operator >(right: StringName) |
|
operator >=(right: StringName) |
Constructor Descriptionsο
StringName StringName() π
Constructs an empty StringName.
StringName StringName(from: StringName)
Constructs a StringName as a copy of the given StringName.
StringName StringName(from: String)
Creates a new StringName from the given String. In GDScript, StringName("example") is equivalent to &"example".
Method Descriptionsο
bool begins_with(text: String) const π
Returns true if the string begins with the given text. See also ends_with().
PackedStringArray bigrams() const π
Returns an array containing the bigrams (pairs of consecutive characters) of this string.
print("Get up!".bigrams()) # Prints ["Ge", "et", "t ", " u", "up", "p!"]
Converts the string representing a binary number into an int. The string may optionally be prefixed with "0b", and an additional - prefix for negative numbers.
print("101".bin_to_int()) # Prints 5
print("0b101".bin_to_int()) # Prints 5
print("-0b10".bin_to_int()) # Prints -2
GD.Print("101".BinToInt()); // Prints 5
GD.Print("0b101".BinToInt()); // Prints 5
GD.Print("-0b10".BinToInt()); // Prints -2
Returns a copy of the string with special characters escaped using the C language standard.
String c_unescape() const π
Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are \', \", \\, \a, \b, \f, \n, \r, \t, \v.
Note: Unlike the GDScript parser, this method doesn't support the \uXXXX escape sequence.
String capitalize() const π
Changes the appearance of the string: replaces underscores (_) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase.
"move_local_x".capitalize() # Returns "Move Local X"
"sceneFile_path".capitalize() # Returns "Scene File Path"
"2D, FPS, PNG".capitalize() # Returns "2d, Fps, Png"
"move_local_x".Capitalize(); // Returns "Move Local X"
"sceneFile_path".Capitalize(); // Returns "Scene File Path"
"2D, FPS, PNG".Capitalize(); // Returns "2d, Fps, Png"
int casecmp_to(to: String) const π
Performs a case-sensitive comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. "Less than" and "greater than" are determined by the Unicode code points of each string, which roughly matches the alphabetical order.
With different string lengths, returns 1 if this string is longer than the to string, or -1 if shorter. Note that the length of empty strings is always 0.
To get a bool result from a string comparison, use the == operator instead. See also nocasecmp_to(), filecasecmp_to(), and naturalcasecmp_to().
bool contains(what: String) const π
Returns true if the string contains what. In GDScript, this corresponds to the in operator.
print("Node".contains("de")) # Prints true
print("team".contains("I")) # Prints false
print("I" in "team") # Prints false
GD.Print("Node".Contains("de")); // Prints True
GD.Print("team".Contains("I")); // Prints False
If you need to know where what is within the string, use find(). See also containsn().
bool containsn(what: String) const π
Returns true if the string contains what, ignoring case.
If you need to know where what is within the string, use findn(). See also contains().
int count(what: String, from: int = 0, to: int = 0) const π
Returns the number of occurrences of the substring what between from and to positions. If to is 0, the search continues until the end of the string.
int countn(what: String, from: int = 0, to: int = 0) const π
Returns the number of occurrences of the substring what between from and to positions, ignoring case. If to is 0, the search continues until the end of the string.
Returns a copy of the string with indentation (leading tabs and spaces) removed. See also indent() to add indentation.
bool ends_with(text: String) const π
Returns true if the string ends with the given text. See also begins_with().
String erase(position: int, chars: int = 1) const π
Returns a string with chars characters erased starting from position. If chars goes beyond the string's length given the specified position, fewer characters will be erased from the returned string. Returns an empty string if either position or chars is negative. Returns the original string unmodified if chars is 0.
int filecasecmp_to(to: String) const π
Like naturalcasecmp_to() but prioritizes strings that begin with periods (.) and underscores (_) before any other character. Useful when sorting folders or file names.
To get a bool result from a string comparison, use the == operator instead. See also filenocasecmp_to(), naturalcasecmp_to(), and casecmp_to().
int filenocasecmp_to(to: String) const π
Like naturalnocasecmp_to() but prioritizes strings that begin with periods (.) and underscores (_) before any other character. Useful when sorting folders or file names.
To get a bool result from a string comparison, use the == operator instead. See also filecasecmp_to(), naturalnocasecmp_to(), and nocasecmp_to().
int find(what: String, from: int = 0) const π
Returns the index of the first occurrence of what in this string, or -1 if there are none. The search's start can be specified with from, continuing to the end of the string.
print("Team".find("I")) # Prints -1
print("Potato".find("t")) # Prints 2
print("Potato".find("t", 3)) # Prints 4
print("Potato".find("t", 5)) # Prints -1
GD.Print("Team".Find("I")); // Prints -1
GD.Print("Potato".Find("t")); // Prints 2
GD.Print("Potato".Find("t", 3)); // Prints 4
GD.Print("Potato".Find("t", 5)); // Prints -1
Note: If you just want to know whether the string contains what, use contains(). In GDScript, you may also use the in operator.
int findn(what: String, from: int = 0) const π
Returns the index of the first case-insensitive occurrence of what in this string, or -1 if there are none. The starting search index can be specified with from, continuing to the end of the string.
String format(values: Variant, placeholder: String = "{_}") const π
Formats the string by replacing all occurrences of placeholder with the elements of values.
values can be a Dictionary, an Array, or an Object. Any underscores in placeholder will be replaced with the corresponding keys in advance. Array elements use their index as keys.
# Prints "Waiting for Godot is a play by Samuel Beckett, and Godot Engine is named after it."
var use_array_values = "Waiting for {0} is a play by {1}, and {0} Engine is named after it."
print(use_array_values.format(["Godot", "Samuel Beckett"]))
# Prints "User 42 is Godot."
print("User {id} is {name}.".format({"id": 42, "name": "Godot"}))
Some additional handling is performed when values is an Array. If placeholder does not contain an underscore, the elements of the values array will be used to replace one occurrence of the placeholder in order; If an element of values is another 2-element array, it'll be interpreted as a key-value pair.
# Prints "User 42 is Godot."
print("User {} is {}.".format([42, "Godot"], "{}"))
print("User {id} is {name}.".format([["id", 42], ["name", "Godot"]]))
When passing an Object, the property names from Object.get_property_list() are used as keys.
# Prints "Visible true, position (0, 0)"
var node = Node2D.new()
print("Visible {visible}, position {position}".format(node))
See also the GDScript format string tutorial.
Note: Each replacement is done sequentially for each element of values, not all at once. This means that if any element is inserted and it contains another placeholder, it may be changed by the next replacement. While this can be very useful, it often causes unexpected results. If not necessary, make sure values's elements do not contain placeholders.
print("{0} {1}".format(["{1}", "x"])) # Prints "x x"
print("{0} {1}".format(["x", "{0}"])) # Prints "x {0}"
print("{a} {b}".format({"a": "{b}", "b": "c"})) # Prints "c c"
print("{a} {b}".format({"b": "c", "a": "{b}"})) # Prints "{b} c"
Note: In C#, it's recommended to interpolate strings with "$", instead.
String get_base_dir() const π
If the string is a valid file path, returns the base directory name.
var dir_path = "/path/to/file.txt".get_base_dir() # dir_path is "/path/to"
String get_basename() const π
If the string is a valid file path, returns the full file path, without the extension.
var base = "/path/to/file.txt".get_basename() # base is "/path/to/file"
String get_extension() const π
If the string is a valid file name or path, returns the file extension without the leading period (.). Otherwise, returns an empty string.
var a = "/path/to/file.txt".get_extension() # a is "txt"
var b = "cool.txt".get_extension() # b is "txt"
var c = "cool.font.tres".get_extension() # c is "tres"
var d = ".pack1".get_extension() # d is "pack1"
var e = "file.txt.".get_extension() # e is ""
var f = "file.txt..".get_extension() # f is ""
var g = "txt".get_extension() # g is ""
var h = "".get_extension() # h is ""
If the string is a valid file path, returns the file name, including the extension.
var file = "/path/to/icon.png".get_file() # file is "icon.png"
String get_slice(delimiter: String, slice: int) const π
Splits the string using a delimiter and returns the substring at index slice. Returns the original string if delimiter does not occur in the string. Returns an empty string if the slice does not exist.
This is faster than split(), if you only need one substring.
print("i/am/example/hi".get_slice("/", 2)) # Prints "example"
int get_slice_count(delimiter: String) const π
Returns the total number of slices when the string is split with the given delimiter (see split()).
String get_slicec(delimiter: int, slice: int) const π
Splits the string using a Unicode character with code delimiter and returns the substring at index slice. Returns an empty string if the slice does not exist.
This is faster than split(), if you only need one substring.
Returns the 32-bit hash value representing the string's contents.
Note: Strings with equal hash values are not guaranteed to be the same, as a result of hash collisions. On the contrary, strings with different hash values are guaranteed to be different.
PackedByteArray hex_decode() const π
Decodes a hexadecimal string as a PackedByteArray.
var text = "hello world"
var encoded = text.to_utf8_buffer().hex_encode() # outputs "68656c6c6f20776f726c64"
print(encoded.hex_decode().get_string_from_utf8())
var text = "hello world";
var encoded = text.ToUtf8Buffer().HexEncode(); // outputs "68656c6c6f20776f726c64"
GD.Print(encoded.HexDecode().GetStringFromUtf8());
Converts the string representing a hexadecimal number into an int. The string may be optionally prefixed with "0x", and an additional - prefix for negative numbers.
print("0xff".hex_to_int()) # Prints 255
print("ab".hex_to_int()) # Prints 171
GD.Print("0xff".HexToInt()); // Prints 255
GD.Print("ab".HexToInt()); // Prints 171
String indent(prefix: String) const π
Indents every line of the string with the given prefix. Empty lines are not indented. See also dedent() to remove indentation.
For example, the string can be indented with two tabulations using "\t\t", or four spaces using " ".
String insert(position: int, what: String) const π
Inserts what at the given position in the string.
bool is_absolute_path() const π
Returns true if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of is_relative_path().
This includes all paths starting with "res://", "user://", "C:\", "/", etc.
Returns true if the string's length is 0 (""). See also length().
bool is_relative_path() const π
Returns true if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current Node (if the string is derived from a NodePath), and may sometimes be prefixed with "./". This method is the opposite of is_absolute_path().
bool is_subsequence_of(text: String) const π
Returns true if all characters of this string can be found in text in their original order.
var text = "Wow, incredible!"
print("inedible".is_subsequence_of(text)) # Prints true
print("Word!".is_subsequence_of(text)) # Prints true
print("Window".is_subsequence_of(text)) # Prints false
print("".is_subsequence_of(text)) # Prints true
bool is_subsequence_ofn(text: String) const π
Returns true if all characters of this string can be found in text in their original order, ignoring case.
bool is_valid_ascii_identifier() const π
Returns true if this string is a valid ASCII identifier. A valid ASCII identifier may contain only letters, digits, and underscores (_), and the first character may not be a digit.
print("node_2d".is_valid_ascii_identifier()) # Prints true
print("TYPE_FLOAT".is_valid_ascii_identifier()) # Prints true
print("1st_method".is_valid_ascii_identifier()) # Prints false
print("MyMethod#2".is_valid_ascii_identifier()) # Prints false
See also is_valid_unicode_identifier().
bool is_valid_filename() const π
Returns true if this string does not contain characters that are not allowed in file names (: / \ ? * " | % < >).
bool is_valid_float() const π
Returns true if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (.), and the exponent letter (e). It may also be prefixed with a positive (+) or negative (-) sign. Any valid integer is also a valid float (see is_valid_int()). See also to_float().
print("1.7".is_valid_float()) # Prints true
print("24".is_valid_float()) # Prints true
print("7e3".is_valid_float()) # Prints true
print("Hello".is_valid_float()) # Prints false
bool is_valid_hex_number(with_prefix: bool = false) const π
Returns true if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters A to F (either uppercase or lowercase), and may be prefixed with a positive (+) or negative (-) sign.
If with_prefix is true, the hexadecimal number needs to prefixed by "0x" to be considered valid.
print("A08E".is_valid_hex_number()) # Prints true
print("-AbCdEf".is_valid_hex_number()) # Prints true
print("2.5".is_valid_hex_number()) # Prints false
print("0xDEADC0DE".is_valid_hex_number(true)) # Prints true
bool is_valid_html_color() const π
Returns true if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see is_valid_hex_number()) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (#). Other HTML notations for colors, such as names or hsl(), are not considered valid. See also Color.html().
bool is_valid_identifier() const π
Deprecated: Use is_valid_ascii_identifier() instead.
Returns true if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (_), and the first character may not be a digit.
print("node_2d".is_valid_identifier()) # Prints true
print("TYPE_FLOAT".is_valid_identifier()) # Prints true
print("1st_method".is_valid_identifier()) # Prints false
print("MyMethod#2".is_valid_identifier()) # Prints false
bool is_valid_int() const π
Returns true if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (+) or negative (-) sign. See also to_int().
print("7".is_valid_int()) # Prints true
print("1.65".is_valid_int()) # Prints false
print("Hi".is_valid_int()) # Prints false
print("+3".is_valid_int()) # Prints true
print("-12".is_valid_int()) # Prints true
bool is_valid_ip_address() const π
Returns true if this string represents a well-formatted IPv4 or IPv6 address. This method considers reserved IP addresses such as "0.0.0.0" and "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff" as valid.
bool is_valid_unicode_identifier() const π
Returns true if this string is a valid Unicode identifier.
A valid Unicode identifier must begin with a Unicode character of class XID_Start or "_", and may contain Unicode characters of class XID_Continue in the other positions.
print("node_2d".is_valid_unicode_identifier()) # Prints true
print("1st_method".is_valid_unicode_identifier()) # Prints false
print("MyMethod#2".is_valid_unicode_identifier()) # Prints false
print("Γ‘llΓ³kΓ©pessΓ©g".is_valid_unicode_identifier()) # Prints true
print("Π²ΡΠ½ΠΎΡΠ»ΠΈΠ²ΠΎΡΡΡ".is_valid_unicode_identifier()) # Prints true
print("δ½ε".is_valid_unicode_identifier()) # Prints true
See also is_valid_ascii_identifier().
Note: This method checks identifiers the same way as GDScript. See TextServer.is_valid_identifier() for more advanced checks.
String join(parts: PackedStringArray) const π
Returns the concatenation of parts' elements, with each element separated by the string calling this method. This method is the opposite of split().
var fruits = ["Apple", "Orange", "Pear", "Kiwi"]
print(", ".join(fruits)) # Prints "Apple, Orange, Pear, Kiwi"
print("---".join(fruits)) # Prints "Apple---Orange---Pear---Kiwi"
string[] fruits = ["Apple", "Orange", "Pear", "Kiwi"];
// In C#, this method is static.
GD.Print(string.Join(", ", fruits)); // Prints "Apple, Orange, Pear, Kiwi"
GD.Print(string.Join("---", fruits)); // Prints "Apple---Orange---Pear---Kiwi"
String json_escape() const π
Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use c_unescape() to unescape the string, if necessary.
String left(length: int) const π
Returns the first length characters from the beginning of the string. If length is negative, strips the last length characters from the string's end.
print("Hello World!".left(3)) # Prints "Hel"
print("Hello World!".left(-4)) # Prints "Hello Wo"
Returns the number of characters in the string. Empty strings ("") always return 0. See also is_empty().
String lpad(min_length: int, character: String = " ") const π
Formats the string to be at least min_length long by adding characters to the left of the string, if necessary. See also rpad().
String lstrip(chars: String) const π
Removes a set of characters defined in chars from the string's beginning. See also rstrip().
Note: chars is not a prefix. Use trim_prefix() to remove a single prefix, rather than a set of characters.
bool match(expr: String) const π
Does a simple expression match (also called "glob" or "globbing"), where * matches zero or more arbitrary characters and ? matches any single character except a period (.). An empty string or empty expression always evaluates to false.
bool matchn(expr: String) const π
Does a simple case-insensitive expression match, where * matches zero or more arbitrary characters and ? matches any single character except a period (.). An empty string or empty expression always evaluates to false.
PackedByteArray md5_buffer() const π
Returns the MD5 hash of the string as a PackedByteArray.
Returns the MD5 hash of the string as another String.
int naturalcasecmp_to(to: String) const π
Performs a case-sensitive, natural order comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. "Less than" or "greater than" are determined by the Unicode code points of each string, which roughly matches the alphabetical order.
When used for sorting, natural order comparison orders sequences of numbers by the combined value of each digit as is often expected, instead of the single digit's value. A sorted sequence of numbered strings will be ["1", "2", "3", ...], not ["1", "10", "2", "3", ...].
With different string lengths, returns 1 if this string is longer than the to string, or -1 if shorter. Note that the length of empty strings is always 0.
To get a bool result from a string comparison, use the == operator instead. See also naturalnocasecmp_to(), filecasecmp_to(), and nocasecmp_to().
int naturalnocasecmp_to(to: String) const π
Performs a case-insensitive, natural order comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. "Less than" or "greater than" are determined by the Unicode code points of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison.
When used for sorting, natural order comparison orders sequences of numbers by the combined value of each digit as is often expected, instead of the single digit's value. A sorted sequence of numbered strings will be ["1", "2", "3", ...], not ["1", "10", "2", "3", ...].
With different string lengths, returns 1 if this string is longer than the to string, or -1 if shorter. Note that the length of empty strings is always 0.
To get a bool result from a string comparison, use the == operator instead. See also naturalcasecmp_to(), filenocasecmp_to(), and casecmp_to().
int nocasecmp_to(to: String) const π
Performs a case-insensitive comparison to another string. Returns -1 if less than, 1 if greater than, or 0 if equal. "Less than" or "greater than" are determined by the Unicode code points of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison.
With different string lengths, returns 1 if this string is longer than the to string, or -1 if shorter. Note that the length of empty strings is always 0.
To get a bool result from a string comparison, use the == operator instead. See also casecmp_to(), filenocasecmp_to(), and naturalnocasecmp_to().
String pad_decimals(digits: int) const π
Formats the string representing a number to have an exact number of digits after the decimal point.
String pad_zeros(digits: int) const π
Formats the string representing a number to have an exact number of digits before the decimal point.
String path_join(file: String) const π
Concatenates file at the end of the string as a subpath, adding / if necessary.
Example: "this/is".path_join("path") == "this/is/path".
String remove_char(what: int) const π
Removes all occurrences of the Unicode character with code what. Faster version of replace() when the key is only one character long and the replacement is "".
String remove_chars(chars: String) const π
Removes any occurrence of the characters in chars. See also remove_char().
String repeat(count: int) const π
Repeats this string a number of times. count needs to be greater than 0. Otherwise, returns an empty string.
String replace(what: String, forwhat: String) const π
Replaces all occurrences of what inside the string with the given forwhat.
String replace_char(key: int, with: int) const π
Replaces all occurrences of the Unicode character with code key with the Unicode character with code with. Faster version of replace() when the key is only one character long. To get a single character use "X".unicode_at(0) (note that some strings, like compound letters and emoji, can be made up of multiple unicode codepoints, and will not work with this method, use length() to make sure).
String replace_chars(keys: String, with: int) const π
Replaces any occurrence of the characters in keys with the Unicode character with code with. See also replace_char().
String replacen(what: String, forwhat: String) const π
Replaces all case-insensitive occurrences of what inside the string with the given forwhat.
Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis.
int rfind(what: String, from: int = -1) const π
Returns the index of the last occurrence of what in this string, or -1 if there are none. The search's start can be specified with from, continuing to the beginning of the string. This method is the reverse of find().
int rfindn(what: String, from: int = -1) const π
Returns the index of the last case-insensitive occurrence of what in this string, or -1 if there are none. The starting search index can be specified with from, continuing to the beginning of the string. This method is the reverse of findn().
String right(length: int) const π
Returns the last length characters from the end of the string. If length is negative, strips the first length characters from the string's beginning.
print("Hello World!".right(3)) # Prints "ld!"
print("Hello World!".right(-4)) # Prints "o World!"
String rpad(min_length: int, character: String = " ") const π
Formats the string to be at least min_length long, by adding characters to the right of the string, if necessary. See also lpad().
PackedStringArray rsplit(delimiter: String = "", allow_empty: bool = true, maxsplit: int = 0) const π
Splits the string using a delimiter and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If delimiter is an empty string, each substring will be a single character.
If allow_empty is false, empty strings between adjacent delimiters are excluded from the array.
If maxsplit is greater than 0, the number of splits may not exceed maxsplit. By default, the entire string is split, which is mostly identical to split().
var some_string = "One,Two,Three,Four"
var some_array = some_string.rsplit(",", true, 1)
print(some_array.size()) # Prints 2
print(some_array[0]) # Prints "One,Two,Three"
print(some_array[1]) # Prints "Four"
// In C#, there is no String.RSplit() method.
String rstrip(chars: String) const π
Removes a set of characters defined in chars from the string's end. See also lstrip().
Note: chars is not a suffix. Use trim_suffix() to remove a single suffix, rather than a set of characters.
PackedByteArray sha1_buffer() const π
Returns the SHA-1 hash of the string as a PackedByteArray.
Returns the SHA-1 hash of the string as another String.
PackedByteArray sha256_buffer() const π
Returns the SHA-256 hash of the string as a PackedByteArray.
String sha256_text() const π
Returns the SHA-256 hash of the string as another String.
float similarity(text: String) const π
Returns the similarity index (SΓΈrensen-Dice coefficient) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar.
print("ABC123".similarity("ABC123")) # Prints 1.0
print("ABC123".similarity("XYZ456")) # Prints 0.0
print("ABC123".similarity("123ABC")) # Prints 0.8
print("ABC123".similarity("abc123")) # Prints 0.4
String simplify_path() const π
If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without "./", and all the unnecessary ".." and "/".
var simple_path = "./path/to///../file".simplify_path()
print(simple_path) # Prints "path/file"
PackedStringArray split(delimiter: String = "", allow_empty: bool = true, maxsplit: int = 0) const π
Splits the string using a delimiter and returns an array of the substrings. If delimiter is an empty string, each substring will be a single character. This method is the opposite of join().
If allow_empty is false, empty strings between adjacent delimiters are excluded from the array.
If maxsplit is greater than 0, the number of splits may not exceed maxsplit. By default, the entire string is split.
var some_array = "One,Two,Three,Four".split(",", true, 2)
print(some_array.size()) # Prints 3
print(some_array[0]) # Prints "One"
print(some_array[1]) # Prints "Two"
print(some_array[2]) # Prints "Three,Four"
// C#'s `Split()` does not support the `maxsplit` parameter.
var someArray = "One,Two,Three".Split(",");
GD.Print(someArray[0]); // Prints "One"
GD.Print(someArray[1]); // Prints "Two"
GD.Print(someArray[2]); // Prints "Three"
Note: If you only need one substring from the array, consider using get_slice() which is faster. If you need to split strings with more complex rules, use the RegEx class instead.
PackedFloat64Array split_floats(delimiter: String, allow_empty: bool = true) const π
Splits the string into floats by using a delimiter and returns a PackedFloat64Array.
If allow_empty is false, empty or invalid float conversions between adjacent delimiters are excluded.
var a = "1,2,4.5".split_floats(",") # a is [1.0, 2.0, 4.5]
var c = "1| ||4.5".split_floats("|") # c is [1.0, 0.0, 0.0, 4.5]
var b = "1| ||4.5".split_floats("|", false) # b is [1.0, 4.5]
String strip_edges(left: bool = true, right: bool = true) const π
Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (\t), and newlines (\n \r).
If left is false, ignores the string's beginning. Likewise, if right is false, ignores the string's end.
String strip_escapes() const π
Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (\t) and newline (\n, \r) characters, but not spaces.
String substr(from: int, len: int = -1) const π
Returns part of the string from the position from with length len. If len is -1 (as by default), returns the rest of the string starting from the given position.
PackedByteArray to_ascii_buffer() const π
Converts the string to an ASCII/Latin-1 encoded PackedByteArray. This method is slightly faster than to_utf8_buffer(), but replaces all unsupported characters with spaces. This is the inverse of PackedByteArray.get_string_from_ascii().
String to_camel_case() const π
Returns the string converted to camelCase.
Converts the string representing a decimal number into a float. This method stops on the first non-number character, except the first decimal point (.) and the exponent letter (e). See also is_valid_float().
var a = "12.35".to_float() # a is 12.35
var b = "1.2.3".to_float() # b is 1.2
var c = "12xy3".to_float() # c is 12.0
var d = "1e3".to_float() # d is 1000.0
var e = "Hello!".to_float() # e is 0.0
Converts the string representing an integer number into an int. This method removes any non-number character and stops at the first decimal point (.). See also is_valid_int().
var a = "123".to_int() # a is 123
var b = "x1y2z3".to_int() # b is 123
var c = "-1.2.3".to_int() # c is -1
var d = "Hello!".to_int() # d is 0
String to_kebab_case() const π
Returns the string converted to kebab-case.
Note: Numbers followed by a single letter are not separated in the conversion to keep some words (such as "2D") together.
"Node2D".to_kebab_case() # Returns "node-2d"
"2nd place".to_kebab_case() # Returns "2-nd-place"
"Texture3DAssetFolder".to_kebab_case() # Returns "texture-3d-asset-folder"
"Node2D".ToKebabCase(); // Returns "node-2d"
"2nd place".ToKebabCase(); // Returns "2-nd-place"
"Texture3DAssetFolder".ToKebabCase(); // Returns "texture-3d-asset-folder"
Returns the string converted to lowercase.
PackedByteArray to_multibyte_char_buffer(encoding: String = "") const π
Converts the string to system multibyte code page encoded PackedByteArray. If conversion fails, empty array is returned.
The values permitted for encoding are system dependent. If encoding is empty string, system default encoding is used.
For Windows, see Code Page Identifiers .NET names.
For macOS and Linux/BSD, see
libiconvlibrary documentation andiconv --listfor a list of supported encodings.
String to_pascal_case() const π
Returns the string converted to PascalCase.
String to_snake_case() const π
Returns the string converted to snake_case.
Note: Numbers followed by a single letter are not separated in the conversion to keep some words (such as "2D") together.
"Node2D".to_snake_case() # Returns "node_2d"
"2nd place".to_snake_case() # Returns "2_nd_place"
"Texture3DAssetFolder".to_snake_case() # Returns "texture_3d_asset_folder"
"Node2D".ToSnakeCase(); // Returns "node_2d"
"2nd place".ToSnakeCase(); // Returns "2_nd_place"
"Texture3DAssetFolder".ToSnakeCase(); // Returns "texture_3d_asset_folder"
Returns the string converted to UPPERCASE.
PackedByteArray to_utf8_buffer() const π
Converts the string to a UTF-8 encoded PackedByteArray. This method is slightly slower than to_ascii_buffer(), but supports all UTF-8 characters. For most cases, prefer using this method. This is the inverse of PackedByteArray.get_string_from_utf8().
PackedByteArray to_utf16_buffer() const π
Converts the string to a UTF-16 encoded PackedByteArray. This is the inverse of PackedByteArray.get_string_from_utf16().
PackedByteArray to_utf32_buffer() const π
Converts the string to a UTF-32 encoded PackedByteArray. This is the inverse of PackedByteArray.get_string_from_utf32().
PackedByteArray to_wchar_buffer() const π
Converts the string to a wide character (wchar_t, UTF-16 on Windows, UTF-32 on other platforms) encoded PackedByteArray. This is the inverse of PackedByteArray.get_string_from_wchar().
String trim_prefix(prefix: String) const π
Removes the given prefix from the start of the string, or returns the string unchanged.
String trim_suffix(suffix: String) const π
Removes the given suffix from the end of the string, or returns the string unchanged.
int unicode_at(at: int) const π
Returns the character code at position at.
String uri_decode() const π
Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. See also uri_encode().
var url = "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
print(url.uri_decode()) # Prints "$DOCS_URL/?highlight=Godot Engine:docs"
var url = "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
GD.Print(url.URIDecode()) // Prints "$DOCS_URL/?highlight=Godot Engine:docs"
Note: This method decodes + as space.
String uri_encode() const π
Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. See also uri_decode().
var prefix = "$DOCS_URL/?highlight="
var url = prefix + "Godot Engine:docs".uri_encode()
print(url) # Prints "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
var prefix = "$DOCS_URL/?highlight=";
var url = prefix + "Godot Engine:docs".URIEncode();
GD.Print(url); // Prints "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
String uri_file_decode() const π
Decodes the file path from its URL-encoded format. Unlike uri_decode() this method leaves + as is.
String validate_filename() const π
Returns a copy of the string with all characters that are not allowed in is_valid_filename() replaced with underscores.
String validate_node_name() const π
Returns a copy of the string with all characters that are not allowed in Node.name (. : @ / " %) replaced with underscores.
String xml_escape(escape_quotes: bool = false) const π
Returns a copy of the string with special characters escaped using the XML standard. If escape_quotes is true, the single quote (') and double quote (") characters are also escaped.
String xml_unescape() const π
Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.
Operator Descriptionsο
bool operator !=(right: String) π
Returns true if this StringName is not equivalent to the given String.
bool operator !=(right: StringName) π
Returns true if the StringName and right do not refer to the same name. Comparisons between StringNames are much faster than regular String comparisons.
String operator %(right: Variant) π
Formats the StringName, replacing the placeholders with one or more parameters, returning a String. To pass multiple parameters, right needs to be an Array.
For more information, see the GDScript format strings tutorial.
Note: In C#, this operator is not available. Instead, see how to interpolate strings with "$".
String operator +(right: String) π
Appends right at the end of this StringName, returning a String. This is also known as a string concatenation.
String operator +(right: StringName) π
Appends right at the end of this StringName, returning a String. This is also known as a string concatenation.
bool operator <(right: StringName) π
Returns true if the left StringName's pointer comes before right. Note that this will not match their Unicode order.
bool operator <=(right: StringName) π
Returns true if the left StringName's pointer comes before right or if they are the same. Note that this will not match their Unicode order.
bool operator ==(right: String) π
Returns true if this StringName is equivalent to the given String.
bool operator ==(right: StringName) π
Returns true if the StringName and right refer to the same name. Comparisons between StringNames are much faster than regular String comparisons.
bool operator >(right: StringName) π
Returns true if the left StringName's pointer comes after right. Note that this will not match their Unicode order.
bool operator >=(right: StringName) π
Returns true if the left StringName's pointer comes after right or if they are the same. Note that this will not match their Unicode order.