String

Category: Built-In Types

Brief Description

Built-in string class.

Methods

Description

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.

Tutorials

• GDScript format strings

Method Descriptions

• String String ( bool from )

Constructs a new String from the given bool.

• String String ( int from )

Constructs a new String from the given int.

• String String ( float from )

Constructs a new String from the given float.

• String String ( Vector2 from )

Constructs a new String from the given Vector2.

• String String ( Rect2 from )

Constructs a new String from the given Rect2.

• String String ( Vector3 from )

Constructs a new String from the given Vector3.

• String String ( Transform2D from )

Constructs a new String from the given Transform2D.

• String String ( Plane from )

Constructs a new String from the given Plane.

• String String ( Quat from )

Constructs a new String from the given Quat.

• String String ( AABB from )

Constructs a new String from the given AABB.

• String String ( Basis from )

Constructs a new String from the given Basis.

• String String ( Transform from )

Constructs a new String from the given Transform.

• String String ( Color from )

Constructs a new String from the given Color.

• String String ( NodePath from )

Constructs a new String from the given NodePath.

• String String ( RID from )

Constructs a new String from the given RID.

• String String ( Dictionary from )

Constructs a new String from the given Dictionary.

• String String ( Array from )

Constructs a new String from the given Array.

• String String ( PoolByteArray from )

Constructs a new String from the given PoolByteArray.

• String String ( PoolIntArray from )

Constructs a new String from the given PoolIntArray.

• String String ( PoolRealArray from )

Constructs a new String from the given PoolRealArray.

• String String ( PoolStringArray from )

Constructs a new String from the given PoolStringArray.

• String String ( PoolVector2Array from )

Constructs a new String from the given PoolVector2Array.

• String String ( PoolVector3Array from )

Constructs a new String from the given PoolVector3Array.

• String String ( PoolColorArray from )

Constructs a new String from the given PoolColorArray.

• bool begins_with ( String text )

Returns true if the string begins with the given string.

• PoolStringArray bigrams ( )

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

• 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 according to the C language standard.

• String capitalize ( )

Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For capitalize camelCase mixed_with_underscores it will return Capitalize Camelcase Mixed With Underscores.

• int casecmp_to ( String to )

Performs a case-sensitive comparison to another string. Returns -1 if less than, +1 if greater than, or 0 if equal.

• String dedent ( )

Removes indentation from string.

• bool empty ( )

Returns true if the string is empty.

• bool ends_with ( String text )

Returns true if the string ends with the given string.

• void erase ( int position, int chars )

Erases chars characters from the string starting from position.

• int find ( String 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.

• int find_last ( String what )

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

• int findn ( String what, int 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 ( Variant values, String placeholder={_} )

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

• String 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.

• String 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.

• int 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"

• String insert ( int position, String what )

Inserts a substring at a given position.

• bool is_abs_path ( )

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

• bool 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 ( String text )

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

• bool is_subsequence_ofi ( String text )

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

• bool is_valid_float ( )

Returns true if this string contains a valid float.

• bool is_valid_hex_number ( bool 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 HTML notation.

• bool 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.

• bool is_valid_ip_address ( )

Returns true if this string contains a valid IP address.

• String json_escape ( )

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

• String left ( int position )

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

• int length ( )

Returns the string’s amount of characters.

• String lstrip ( String chars )

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

• bool match ( String expr )

Does a simple expression match, where * matches zero or more arbitrary characters and ? matches any single character except ‘.’.

• bool matchn ( String expr )

Does a simple case insensitive expression match, using ? and * wildcards (see match).

• PoolByteArray 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.

• int nocasecmp_to ( String to )

Performs a case-insensitive comparison to another string. Returns -1 if less than, +1 if greater than, or 0 if equal.

• int ord_at ( int at )

Returns the character code at position at.

• String pad_decimals ( int digits )

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

• String pad_zeros ( int digits )

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

• String percent_decode ( )

Decode a percent-encoded string. See percent_encode.

• String 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 ( String 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 replace ( String what, String forwhat )

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

• String replacen ( String what, String forwhat )

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

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

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

• int rfindn ( String what, int from=-1 )

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

• String right ( int position )

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

• PoolStringArray rsplit ( String delimiter, bool allow_empty=True, int 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"

• String rstrip ( String chars )

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

• PoolByteArray 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.

• float similarity ( String text )

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

• PoolStringArray split ( String delimiter, bool allow_empty=True, int maxsplit=0 )

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

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:

var some_string = "One,Two,Three,Four"
var some_array = some_string.split(",", true, 1)
print(some_array.size()) # Prints 2
print(some_array[0]) # Prints "One"
print(some_array[1]) # Prints "Two,Three,Four"

• PoolRealArray split_floats ( String delimiter, bool allow_empty=True )

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

Example: "1,2.5,3" will return [1,2.5,3] if split by ",".

• String strip_edges ( bool left=True, bool right=True )

Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.

• String substr ( int from, int len )

Returns part of the string from the position from with length len.

• PoolByteArray to_ascii ( )

Converts the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is sped up in comparison to to_utf8 with the assumption that all the characters the String contains are only ASCII characters.

• float to_float ( )

Converts a string containing a decimal number into a float.

• int to_int ( )

Converts a string containing an integer number into an int.

• String to_lower ( )

Returns the string converted to lowercase.

• String to_upper ( )

Returns the string converted to uppercase.

• PoolByteArray 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 to_ascii, but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii.

• String trim_prefix ( String prefix )

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

• String trim_suffix ( String suffix )

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

• String xml_escape ( )

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

• String xml_unescape ( )

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