String

This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference-counted and use a copy-on-write approach, so passing them around is cheap in resources.

• String String ( from )

Constructs a new String from the given bool.

• String ( int from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given float.

• String ( Vector2 from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Rect2.

• String ( Vector3 from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Transform2D.

• String ( Plane from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Quat.

• String ( AABB from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Basis.

• String ( Transform from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Color.

• String ( NodePath from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given RID.

• String ( Dictionary from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given Array.

• String ( PoolByteArray from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given PoolIntArray.

• String ( PoolRealArray from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given PoolStringArray.

• String ( PoolVector2Array from )

Constructs a new String from the given .

• String String ( from )

Constructs a new String from the given PoolVector3Array.

• String ( PoolColorArray from )

Constructs a new String from the given .

• bool begins_with ( text )

Returns if the string begins with the given string.

• PoolStringArray bigrams ( )

Returns the bigrams (pairs of consecutive letters) of this string.

• c_escape ( )

Returns a copy of the string with special characters escaped using the C language standard.

• String c_unescape ( )

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.

• capitalize ( )

Changes the case of some letters. Replaces underscores with spaces, adds spaces before in-word uppercase characters, converts all letters to lowercase, then capitalizes the first letter and every letter following a space character. For capitalize camelCase mixed_with_underscores, it will return Capitalize Camel Case Mixed With Underscores.

• int casecmp_to ( to )

Performs a case-sensitive 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.

Behavior with different string lengths: Returns 1 if the “base” string is longer than the to string or -1 if the “base” string is shorter than the to string. Keep in mind this length is determined by the number of Unicode codepoints, not the actual visible characters.

Behavior with empty strings: Returns -1 if the “base” string is empty, 1 if the to string is empty or 0 if both strings are empty.

To get a boolean result from a string comparison, use the == operator instead. See also nocasecmp_to.

• count ( String what, from=0, int to=0 )

Returns the number of occurrences of substring what between from and to positions. If from and to equals 0 the whole string will be used. If only to equals 0 the remained substring will be used.

• countn ( String what, from=0, int to=0 )

Returns the number of occurrences of substring what (ignoring case) between from and to positions. If from and to equals 0 the whole string will be used. If only to equals 0 the remained substring will be used.

• dedent ( )

Returns a copy of the string with indentation (leading tabs and spaces) removed.

Returns true if the length of the string equals 0.

• bool ends_with ( text )

• void erase ( int position, chars )

Erases chars characters from the string starting from position.

• int find ( what, int from=0 )

Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.

Note: If you just want to know whether a string contains a substring, use the in operator as follows:

• find_last ( String what )

Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found.

• findn ( String what, from=0 )

Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.

• String format ( values, String placeholder=”{_}” )

Formats the string by replacing all occurrences of placeholder with values.

• get_base_dir ( )

If the string is a valid file path, returns the base directory name.

• String get_basename ( )

If the string is a valid file path, returns the full file path without the extension.

• get_extension ( )

If the string is a valid file path, returns the extension.

• String get_file ( )

If the string is a valid file path, returns the filename.

• hash ( )

Hashes the string and returns a 32-bit integer.

• int hex_to_int ( )

Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with “0x“ otherwise 0 is returned.

print("0xff".hex_to_int()) # Print "255"

• http_escape ( )

Escapes (encodes) a string to URL friendly format. Also referred to as ‘URL encode’.

• String http_unescape ( )

Unescapes (decodes) a string in URL encoded format. Also referred to as ‘URL decode’.

print("https://example.org/?escaped=" + "Godot%20Engine%3A%27docs%27".http_unescape())

• humanize_size ( int size )

Converts size represented as number of bytes to human-readable format using internationalized set of data size units, namely: B, KiB, MiB, GiB, TiB, PiB, EiB. Note that the next smallest unit is picked automatically to hold at most 1024 units.

• insert ( int position, what )

Returns a copy of the string with the substring what inserted at the given position.

• bool is_abs_path ( )

If the string is a path to a file or directory, returns true if the path is absolute.

• is_rel_path ( )

If the string is a path to a file or directory, returns true if the path is relative.

• bool is_subsequence_of ( text )

Returns true if this string is a subsequence of the given string.

• bool is_subsequence_ofi ( text )

Returns true if this string is a subsequence of the given string, without considering case.

• bool is_valid_filename ( )

Returns true if this string is free from characters that aren’t allowed in file names, those being:

: / \ ? * " | % < >

• is_valid_float ( )

Returns true if this string contains a valid float.

• bool is_valid_hex_number ( with_prefix=false )

Returns true if this string contains a valid hexadecimal number. If with_prefix is true, then a validity of the hexadecimal number is determined by 0x prefix, for instance: 0xDEADC0DE.

• bool is_valid_html_color ( )

Returns true if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or hsl() colors aren’t considered valid by this method and will return false.

• is_valid_identifier ( )

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.

• bool is_valid_integer ( )

Returns true if this string contains a valid integer.

• is_valid_ip_address ( )

Returns true if this string contains only a well-formatted IPv4 or IPv6 address. This method considers reserved IP addresses such as 0.0.0.0 as valid.

• json_escape ( )

Returns a copy of the string with special characters escaped using the JSON standard.

• String left ( position )

Returns a number of characters from the left of the string.

• int length ( )

Returns the string’s amount of characters.

• lstrip ( String chars )

Returns a copy of the string with characters removed from the left.

• match ( String expr )

Does a simple case-sensitive expression match, where "*" matches zero or more arbitrary characters and "?" matches any single character except a period (".").

• matchn ( String expr )

Does a simple case-insensitive expression match, where "*" matches zero or more arbitrary characters and "?" matches any single character except a period (".").

• md5_buffer ( )

Returns the MD5 hash of the string as an array of bytes.

• String md5_text ( )

Returns the MD5 hash of the string as a string.

• nocasecmp_to ( String to )

Performs a case-insensitive comparison to another string. Returns 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 will be converted to uppercase during the comparison.

Behavior with different string lengths: Returns 1 if the “base” string is longer than the to string or -1 if the “base” string is shorter than the to string. Keep in mind this length is determined by the number of Unicode codepoints, not the actual visible characters.

Behavior with empty strings: Returns -1 if the “base” string is empty, 1 if the to string is empty or 0 if both strings are empty.

Returns the character code at position at.

• pad_decimals ( int digits )

Formats a number to have an exact number of digits after the decimal point.

• pad_zeros ( int digits )

Formats a number to have an exact number of digits before the decimal point.

• percent_decode ( )

Decode a percent-encoded string. See percent_encode.

• percent_encode ( )

Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests).

• String plus_file ( file )

If the string is a path, this concatenates file at the end of the string as a subpath. E.g. "this/is".plus_file("path") == "this/is/path".

• String repeat ( count )

Returns original string repeated a number of times. The number of repetitions is given by the argument.

• String replace ( what, String forwhat )

Replaces occurrences of a case-sensitive substring with the given one inside the string.

• replacen ( String what, forwhat )

Replaces occurrences of a case-insensitive substring with the given one inside the string.

• int rfind ( what, int from=-1 )

Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning.

• rfindn ( String what, from=-1 )

Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning.

• String right ( position )

Returns the right side of the string from a given position.

• PoolStringArray rsplit ( delimiter, bool allow_empty=true, maxsplit=0 )

Splits the string by a delimiter string and returns an array of the substrings, starting from right.

The splits in the returned array are sorted in the same order as the original string, from left to right.

If maxsplit is specified, it defines the number of splits to do from the right up to maxsplit. The default value of 0 means that all items are split, thus giving the same result as split.

Example:

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 "Four"
print(some_array[1]) # Prints "Three,Two,One"

• rstrip ( String chars )

Returns a copy of the string with characters removed from the right.

• sha1_buffer ( )

Returns the SHA-1 hash of the string as an array of bytes.

• String sha1_text ( )

Returns the SHA-1 hash of the string as a string.

• sha256_buffer ( )

Returns the SHA-256 hash of the string as an array of bytes.

• String sha256_text ( )

Returns the SHA-256 hash of the string as a string.

• similarity ( String text )

Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.

• split ( String delimiter, allow_empty=true, int maxsplit=0 )

Splits the string by a delimiter string and returns an array of the substrings. The delimiter can be of any length.

If maxsplit is specified, it defines the number of splits to do from the left up to maxsplit. The default value of 0 means that all items are split.

Example:

If you need to split strings with more complex rules, use the class instead.

• PoolRealArray split_floats ( delimiter, bool allow_empty=true )

Splits the string in floats by using a delimiter string and returns an array of the substrings.

For example, "1,2.5,3" will return [1,2.5,3] if split by ",".

• strip_edges ( bool left=true, right=true )

Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.

• String strip_escapes ( )

Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation (\t in C) and newline (\n and \r) characters, but not spaces.

• substr ( int from, len=-1 )

Returns part of the string from the position from with length len. Argument len is optional and using -1 will return remaining characters from given position.

• PoolByteArray to_ascii ( )

Converts the String (which is a character array) to (which is an array of bytes). The conversion is faster compared to to_utf8, as this method assumes that all the characters in the String are ASCII characters.

• to_float ( )

Converts a string containing a decimal number into a float.

• int to_int ( )

Converts a string containing an integer number into an .

• to_lower ( )

Returns the string converted to lowercase.

• String to_upper ( )

Returns the string converted to uppercase.

• to_utf8 ( )

Converts the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than , but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii.

• trim_prefix ( String prefix )

Removes a given string from the start if it starts with it or leaves the string unchanged.

• trim_suffix ( String suffix )

Removes a given string from the end if it ends with it or leaves the string unchanged.

• xml_escape ( )

• String xml_unescape ( )

Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.