This is the built-in string Variant type (and the one used by GDScript). Strings may contain any number of Unicode characters, and expose methods useful for manipulating and generating strings. Strings are reference-counted and use a copy-on-write approach (every modification to a string returns a new String), so passing them around is cheap in resources.
Some string methods have corresponding variations. Variations suffixed with n
(countn, findn, replacen, etc.) are case-insensitive (they make no distinction between uppercase and lowercase letters). Method variations prefixed with r
(rfind, rsplit, etc.) are reversed, and start from the end of the string, instead of the beginning.
Constructs an empty String (""
).
Constructs a String as a copy of the given String.
Constructs a new String from the given NodePath.
Constructs a new String from the given StringName.
Returns true
if both strings do not contain the same sequence of characters.
Returns true
if this String is not equivalent to the given StringName.
Formats the String, replacing the placeholders with one or more parameters. 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 "$".
Appends right
at the end of this String, also known as a string concatenation.
Appends right
at the end of this String, returning a String. This is also known as a string concatenation.
Returns true
if the left String comes before right
in Unicode order, which roughly matches the alphabetical order. Useful for sorting.
Returns true
if the left String comes before right
in Unicode order, which roughly matches the alphabetical order, or if both are equal.
Returns true
if both strings contain the same sequence of characters.
Returns true
if this String is equivalent to the given StringName.
Returns true
if the left String comes after right
in Unicode order, which roughly matches the alphabetical order. Useful for sorting.
Returns true
if the left String comes after right
in Unicode order, which roughly matches the alphabetical order, or if both are equal.
Returns a new String that only contains the character at index
. Indices start from 0
. If index
is greater or equal to 0
, the character is fetched starting from the beginning of the string. If index
is a negative value, it is fetched starting from the end. Accessing a string out-of-bounds will cause a run-time error, pausing the project execution if run from the editor.
Returns true
if the string begins with the given text
. See also ends_with.
Returns an array containing the bigrams (pairs of consecutive characters) of this string.
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.
Returns a copy of the string with special characters escaped using the C language standard.
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.
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.
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, naturalcasecmp_to, and naturalnocasecmp_to.
Returns a single Unicode character from the decimal char
. You may use unicodelookup.com or unicode.org as points of reference.
Returns true
if the string contains what
. In GDScript, this corresponds to the in
operator.
If you need to know where what
is within the string, use find.
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.
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.
Returns true
if the string ends with the given text
. See also begins_with.
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
.
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.
Note: If you just want to know whether the string contains what
, use contains. In GDScript, you may also use the in
operator.
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.
Formats the string by replacing all occurrences of placeholder
with the elements of values
.
values
can be a Dictionary or an Array. Any underscores in placeholder
will be replaced with the corresponding keys in advance. Array elements use their index as keys.
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.
See also the GDScript format string tutorial.
Note: In C#, it's recommended to interpolate strings with "$", instead.
If the string is a valid file path, returns the base directory name.
If the string is a valid file path, returns the full file path, without the extension.
If the string is a valid file name or path, returns the file extension without the leading period (.
). Otherwise, returns an empty string.
If the string is a valid file path, returns the file name, including the extension.
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.
Example:
Returns the total number of slices when the string is split with the given delimiter
(see split).
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.
Decodes a hexadecimal string as a PackedByteArray.
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.
Converts size
which represents a number of bytes into a human-readable form.
The result is in IEC prefix format, which may end in either "B"
, "KiB"
, "MiB"
, "GiB"
, "TiB"
, "PiB"
, or "EiB"
.
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 " "
.
Inserts what
at the given position
in the string.
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.
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.
Returns true
if all characters of this string can be found in text
in their original order.
Returns true
if all characters of this string can be found in text
in their original order, ignoring case.
Returns true
if this string does not contain characters that are not allowed in file names (:
/
\
?
*
"
|
%
<
>
).
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.
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.
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.
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.
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.
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.
Returns the concatenation of parts
' elements, with each element separated by the string calling this method. This method is the opposite of split.
Example:
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.
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.
Returns the number of characters in the string. Empty strings (""
) always return 0
. See also is_empty.
Formats the string to be at least min_length
long by adding character
s to the left of the string, if necessary. See also rpad.
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.
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
.
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
.
Returns the MD5 hash of the string as a PackedByteArray.
Returns the MD5 hash of the string as another String.
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, nocasecmp_to, and casecmp_to.
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, nocasecmp_to, and casecmp_to.
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, naturalcasecmp_to, and naturalnocasecmp_to.
Converts a float to a string representation of a decimal number, with the number of decimal places specified in decimals
.
If decimals
is -1
as by default, the string representation may only have up to 14 significant digits, with digits before the decimal point having priority over digits after.
Trailing zeros are not included in the string. The last digit is rounded, not truncated.
Example:
Converts the given number
to a string representation, with the given base
.
By default, base
is set to decimal (10
). Other common bases in programming include binary (2
), octal (8
), hexadecimal (16
).
If capitalize_hex
is true
, digits higher than 9 are represented in uppercase.
Converts the given number
to a string representation, in scientific notation.
Note: In C#, this method is not implemented. To achieve similar results, see C#'s Standard numeric format strings
Converts the given unsigned int to a string representation, with the given base
.
By default, base
is set to decimal (10
). Other common bases in programming include binary (2
), octal (8
), hexadecimal (16
).
If capitalize_hex
is true
, digits higher than 9 are represented in uppercase.
Formats the string representing a number to have an exact number of digits
after the decimal point.
Formats the string representing a number to have an exact number of digits
before the decimal point.
Concatenates file
at the end of the string as a subpath, adding /
if necessary.
Example: "this/is".path_join("path") == "this/is/path"
.
Repeats this string a number of times. count
needs to be greater than 0
. Otherwise, returns an empty string.
Replaces all occurrences of what
inside the string with the given forwhat
.
Replaces all case-insensitive occurrences of what
inside the string with the given forwhat
.
Returns the copy of this string in reverse order.
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.
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.
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.
Formats the string to be at least min_length
long, by adding character
s to the right of the string, if necessary. See also lpad.
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.
Example:
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.
Returns the SHA-1 hash of the string as a PackedByteArray.
Returns the SHA-1 hash of the string as another String.
Returns the SHA-256 hash of the string as a PackedByteArray.
Returns the SHA-256 hash of the string as another String.
Returns the similarity index (Sorensen-Dice coefficient) of this string compared to another. A result of 1.0
means totally similar, while 0.0
means totally dissimilar.
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 "/"
.
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.
Example:
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.
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.
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.
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.
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.
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.
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.
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.
Returns the string converted to lowercase
.
Returns the string converted to PascalCase
.
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.
Returns the string converted to UPPERCASE
.
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.
Converts the string to a UTF-16 encoded PackedByteArray. This is the inverse of PackedByteArray.get_string_from_utf16.
Converts the string to a UTF-32 encoded PackedByteArray. This is the inverse of PackedByteArray.get_string_from_utf32.
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.
Removes the given prefix
from the start of the string, or returns the string unchanged.
Removes the given suffix
from the end of the string, or returns the string unchanged.
Returns the character code at position at
.
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.
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.
Returns a copy of the string with all characters that are not allowed in is_valid_filename replaced with underscores.
Returns a copy of the string with all characters that are not allowed in Node.name (.
:
@
/
"
%
) replaced with underscores.
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.
Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.