String¶
Category: Built-In Types
Brief Description¶
Built-in string class.
Member Functions¶
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.
Member Function Description¶
Constructs a new String from the given bool.
Constructs a new String from the given int.
Constructs a new String from the given float.
Constructs a new String from the given Vector2.
Constructs a new String from the given Rect2.
Constructs a new String from the given Vector3.
- String String ( Transform2D from )
Constructs a new String from the given Transform2D.
Constructs a new String from the given Plane.
Constructs a new String from the given Quat.
Constructs a new String from the given AABB.
Constructs a new String from the given Basis.
Constructs a new String from the given Transform.
Constructs a new String from the given Color.
Constructs a new String from the given NodePath.
Constructs a new String from the given RID.
- String String ( Dictionary from )
Constructs a new String from the given Dictionary.
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.
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
.
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.
Returns true
if the string ends with the given string.
Erases chars
characters from the string starting from position
.
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.
Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found.
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.
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.
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.
Returns true
if this string is a subsequence of the given string.
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_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.
Returns a number of characters from the left of the string.
- int length ( )
Returns the string’s amount of characters.
Does a simple expression match, where ‘*’ matches zero or more arbitrary characters and ‘?’ matches any single character except ‘.’.
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.
Performs a case-insensitive comparison to another string. Returns -1
if less than, +1
if greater than, or 0
if equal.
Returns the character code at position at
.
Formats a number to have an exact number of digits
after the decimal point.
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).
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"
.
Replaces occurrences of a substring with the given one inside the string.
Replaces occurrences of a substring with the given one inside the string. Ignores case.
Performs a search for a substring, but starts from the end of the string instead of the beginning.
Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case.
Returns the right side of the string from a given position.
- PoolByteArray sha256_buffer ( )
- String sha256_text ( )
Returns the SHA-256 hash of the string as a string.
Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
- PoolStringArray split ( String divisor, bool allow_empty=True, int maxsplit=0 )
Splits the string by a divisor string and returns an array of the substrings. Example “One,Two,Three” will return “One”,”Two”,”Three” if split by “,”.
If maxsplit
is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements)
- PoolRealArray split_floats ( String divisor, bool allow_empty=True )
Splits the string in floats by using a divisor string and returns an array of the substrings. Example “1,2.5,3” will return 1,2.5,3 if split by “,”.
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.
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 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.