String¶
Built-in string class.
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¶
Methods¶
String(Transform2D from) | |
String(Dictionary from) | |
String(PoolByteArray from) | |
String(PoolIntArray from) | |
String(PoolRealArray from) | |
String(PoolStringArray from) | |
String(PoolVector2Array from) | |
String(PoolVector3Array from) | |
String(PoolColorArray from) | |
begins_with(String text) | |
bigrams() | |
c_escape() | |
casecmp_to(String to) | |
dedent() | |
empty() | |
void | |
get_file() | |
hash() | |
humanize_size(int size) | |
is_subsequence_of(String text) | |
is_subsequence_ofi(String text) | |
is_valid_hex_number(bool with_prefix=false) | |
length() | |
md5_text() | |
nocasecmp_to(String to) | |
pad_decimals(int digits) | |
rsplit(String delimiter,bool allow_empty=true,int maxsplit=0) | |
similarity(String text) | |
split(String delimiter,bool allow_empty=true,int maxsplit=0) | |
split_floats(String delimiter,bool allow_empty=true) | |
strip_edges(bool left=true,bool right=true) | |
to_ascii() | |
to_float() | |
to_int() | |
to_lower() | |
to_upper() | |
to_utf8() | |
to_wchar() | |
trim_prefix(String prefix) | |
trim_suffix(String suffix) | |
Method Descriptions¶
Constructs a new String from the givenbool.
Constructs a new String from the givenint.
Constructs a new String from the givenfloat.
Constructs a new String from the givenVector2.
Constructs a new String from the givenRect2.
Constructs a new String from the givenVector3.
StringString(Transform2D from)
Constructs a new String from the givenTransform2D.
Constructs a new String from the givenPlane.
Constructs a new String from the givenQuat.
Constructs a new String from the givenAABB.
Constructs a new String from the givenBasis.
Constructs a new String from the givenTransform.
Constructs a new String from the givenColor.
Constructs a new String from the givenNodePath.
Constructs a new String from the givenRID.
StringString(Dictionary from)
Constructs a new String from the givenDictionary.
Constructs a new String from the givenArray.
StringString(PoolByteArray from)
Constructs a new String from the givenPoolByteArray.
StringString(PoolIntArray from)
Constructs a new String from the givenPoolIntArray.
StringString(PoolRealArray from)
Constructs a new String from the givenPoolRealArray.
StringString(PoolStringArray from)
Constructs a new String from the givenPoolStringArray.
StringString(PoolVector2Array from)
Constructs a new String from the givenPoolVector2Array.
StringString(PoolVector3Array from)
Constructs a new String from the givenPoolVector3Array.
StringString(PoolColorArray from)
Constructs a new String from the givenPoolColorArray.
Returnstrue if the string begins with the given string.
PoolStringArraybigrams()
Returns an array containing the bigrams (pairs of consecutive letters) of this string.
print("Bigrams".bigrams())# Prints "[Bi, ig, gr, ra, am, ms]"
Stringc_escape()
Returns a copy of the string with special characters escaped using the C language standard.
Stringc_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.
Stringcapitalize()
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. ForcapitalizecamelCasemixed_with_underscores, it will returnCapitalizeCamelCaseMixedWithUnderscores.
Performs a case-sensitive comparison to another string. Returns-1 if less than,1 if greater than, or0 if equal. "less than" or "greater than" are determined by theUnicode code points of each string, which roughly matches the alphabetical order.
Behavior with different string lengths: Returns1 if the "base" string is longer than theto string or-1 if the "base" string is shorter than theto 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 theto string is empty or0 if both strings are empty.
To get a boolean result from a string comparison, use the== operator instead. See alsonocasecmp_to.
Returns the number of occurrences of substringwhat betweenfrom andto positions. Iffrom andto equals 0 the whole string will be used. If onlyto equals 0 the remained substring will be used.
Returns the number of occurrences of substringwhat (ignoring case) betweenfrom andto positions. Iffrom andto equals 0 the whole string will be used. If onlyto equals 0 the remained substring will be used.
Stringdedent()
Returns a copy of the string with indentation (leading tabs and spaces) removed. See alsoindent to add indentation.
boolempty()
Returnstrue if the length of the string equals0.
Returnstrue if the string ends with the given string.
Eraseschars characters from the string starting fromposition.
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 thein operator as follows:
# Will evaluate to `false`.if"i"in"team":pass
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 ofplaceholder withvalues.
Stringget_base_dir()
If the string is a valid file path, returns the base directory name.
Stringget_basename()
If the string is a valid file path, returns the full file path without the extension.
Stringget_extension()
Returns the extension without the leading period character (.) if the string is a valid file name or path. If the string does not contain an extension, returns an empty string instead.
print("/path/to/file.txt".get_extension())# "txt"print("file.txt".get_extension())# "txt"print("file.sample.txt".get_extension())# "txt"print(".txt".get_extension())# "txt"print("file.txt.".get_extension())# "" (empty string)print("file.txt..".get_extension())# "" (empty string)print("txt".get_extension())# "" (empty string)print("".get_extension())# "" (empty string)
Stringget_file()
If the string is a valid file path, returns the filename.
inthash()
Returns the 32-bit hash value representing the string's contents.
Note:Strings with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values doesnot imply the strings are equal, because different strings can have identical hash values due to hash collisions.
inthex_to_int()
Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "0x" otherwise0 is returned.
print("0xff".hex_to_int())# Print "255"
Stringhttp_escape()
Escapes (encodes) a string to URL friendly format. Also referred to as 'URL encode'.
print("https://example.org/?escaped="+"Godot Engine:'docs'".http_escape())
Stringhttp_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())
Convertssize 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.
varbytes=133790307varsize=String.humanize_size(bytes)print(size)# prints "127.5 MiB"
Returns a copy of the string with lines indented withprefix.
For example, the string can be indented with two tabs using"\t\t", or four spaces using" ". The prefix can be any string so it can also be used to comment out strings with e.g."#". See alsodedent to remove indentation.
Note: Empty lines are kept empty.
Returns a copy of the string with the substringwhat inserted at the given position.
boolis_abs_path()
If the string is a path to a file or directory, returnstrue if the path is absolute.
boolis_rel_path()
If the string is a path to a file or directory, returnstrue if the path is relative.
Returnstrue if this string is a subsequence of the given string.
Returnstrue if this string is a subsequence of the given string, without considering case.
boolis_valid_filename()
Returnstrue if this string is free from characters that aren't allowed in file names, those being:
:/\?*"|%<>
boolis_valid_float()
Returnstrue if this string contains a valid float. This is inclusive of integers, and also supports exponents:
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"
Returnstrue if this string contains a valid hexadecimal number. Ifwith_prefix istrue, then a validity of the hexadecimal number is determined by0x prefix, for instance:0xDEADC0DE.
boolis_valid_html_color()
Returnstrue if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors orhsl() colors aren't considered valid by this method and will returnfalse.
boolis_valid_identifier()
Returnstrue 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("good_ident_1".is_valid_identifier())# Prints "True"print("1st_bad_ident".is_valid_identifier())# Prints "False"print("bad_ident_#2".is_valid_identifier())# Prints "False"
boolis_valid_integer()
Returnstrue if this string contains a valid integer.
print("7".is_valid_int())# Prints "True"print("14.6".is_valid_int())# Prints "False"print("L".is_valid_int())# Prints "False"print("+3".is_valid_int())# Prints "True"print("-12".is_valid_int())# Prints "True"
boolis_valid_ip_address()
Returnstrue if this string contains only a well-formatted IPv4 or IPv6 address. This method considersreserved IP addresses such as0.0.0.0 as valid.
Stringjson_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.
intlength()
Returns the string's amount of characters.
Returns a copy of the string with characters removed from the left. Thechars argument is a string specifying the set of characters to be removed.
Note: Thechars is not a prefix. Seetrim_prefix method that will remove a single prefix string rather than a set of characters.
Does a simple case-sensitive 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 tofalse.
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 tofalse.
PoolByteArraymd5_buffer()
Returns the MD5 hash of the string as an array of bytes.
Stringmd5_text()
Returns the MD5 hash of the string as a string.
Performs a case-insensitivenatural order comparison to another string. Returns-1 if less than,1 if greater than, or0 if equal. "less than" or "greater than" are determined by theUnicode code points of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison.
When used for sorting, natural order comparison will order suites of numbers as expected by most people. If you sort the numbers from 1 to 10 using natural order, you will get[1,2,3,...] instead of[1,10,2,3,...].
Behavior with different string lengths: Returns1 if the "base" string is longer than theto string or-1 if the "base" string is shorter than theto 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 theto string is empty or0 if both strings are empty.
To get a boolean result from a string comparison, use the== operator instead. See alsonocasecmp_to andcasecmp_to.
Performs a case-insensitive comparison to another string. Returns-1 if less than,1 if greater than, or0 if equal. "less than" or "greater than" are determined by theUnicode 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: Returns1 if the "base" string is longer than theto string or-1 if the "base" string is shorter than theto 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 theto string is empty or0 if both strings are empty.
To get a boolean result from a string comparison, use the== operator instead. See alsocasecmp_to.
Returns the character code at positionat.
Formats a number to have an exact number ofdigits after the decimal point.
Formats a number to have an exact number ofdigits before the decimal point.
Stringpercent_decode()
Decode a percent-encoded string. Seepercent_encode.
Stringpercent_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 concatenatesfile at the end of the string as a subpath. E.g."this/is".plus_file("path")=="this/is/path".
Returns original string repeated a number of times. The number of repetitions is given by the argument.
Replaces occurrences of a case-sensitive substring with the given one inside the string.
Replaces occurrences of a case-insensitive substring with the given one inside the string.
Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning.
Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning.
Returns the right side of the string from a given position.
PoolStringArrayrsplit(String delimiter,bool allow_empty=true,int maxsplit=0)
Splits the string by adelimiter 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.
Ifmaxsplit is specified, it defines the number of splits to do from the right up tomaxsplit. The default value of 0 means that all items are split, thus giving the same result assplit.
Example:
varsome_string="One,Two,Three,Four"varsome_array=some_string.rsplit(",",true,1)print(some_array.size())# Prints 2print(some_array[0])# Prints "One,Two,Three"print(some_array[1])# Prints "Four"
Returns a copy of the string with characters removed from the right. Thechars argument is a string specifying the set of characters to be removed.
Note: Thechars is not a suffix. Seetrim_suffix method that will remove a single suffix string rather than a set of characters.
PoolByteArraysha1_buffer()
Returns the SHA-1 hash of the string as an array of bytes.
Stringsha1_text()
Returns the SHA-1 hash of the string as a string.
PoolByteArraysha256_buffer()
Returns the SHA-256 hash of the string as an array of bytes.
Stringsha256_text()
Returns the SHA-256 hash of the string as a 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.
print("ABC123".similarity("ABC123"))# Prints "1"print("ABC123".similarity("XYZ456"))# Prints "0"print("ABC123".similarity("123ABC"))# Prints "0.8"print("ABC123".similarity("abc123"))# Prints "0.4"
Stringsimplify_path()
Returns a simplified canonical path.
PoolStringArraysplit(String delimiter,bool allow_empty=true,int maxsplit=0)
Splits the string by adelimiter string and returns an array of the substrings. Thedelimiter can be of any length.
Ifmaxsplit is specified, it defines the number of splits to do from the left up tomaxsplit. The default value of0 means that all items are split.
Example:
varsome_string="One,Two,Three,Four"varsome_array=some_string.split(",",true,1)print(some_array.size())# Prints 2print(some_array[0])# Prints "One"print(some_array[1])# Prints "Two,Three,Four"
If you need to split strings with more complex rules, use theRegEx class instead.
PoolRealArraysplit_floats(String 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",".
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.
Stringstrip_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.
Returns part of the string from the positionfrom with lengthlen. Argumentlen is optional and using-1 will return remaining characters from given position.
PoolByteArrayto_ascii()
Converts the String (which is a character array) toPoolByteArray (which is an array of bytes). The conversion is faster compared toto_utf8, as this method assumes that all the characters in the String are ASCII characters.
floatto_float()
Converts a string containing a decimal number into afloat. The method will stop on the first non-number character except the first. (decimal point), ande which is used for exponential.
print("12.3".to_float())# 12.3print("1.2.3".to_float())# 1.2print("12ab3".to_float())# 12print("1e3".to_float())# 1000
intto_int()
Converts a string containing an integer number into anint. The method will remove any non-number character and stop if it encounters a..
print("123".to_int())# 123print("a1b2c3".to_int())# 123print("1.2.3".to_int())# 1
Stringto_lower()
Returns the string converted to lowercase.
Stringto_upper()
Returns the string converted to uppercase.
PoolByteArrayto_utf8()
Converts the String (which is an array of characters) toPoolByteArray (which is an array of bytes). The conversion is a bit slower thanto_ascii, but supports all UTF-8 characters. Therefore, you should prefer this function overto_ascii.
PoolByteArrayto_wchar()
Converts the String (which is an array of characters) toPoolByteArray (which is an array of bytes).
Removes a given string from the start if it starts with it or leaves the string unchanged.
Removes a given string from the end if it ends with it or leaves the string unchanged.
Stringvalidate_node_name()
Removes any characters from the string that are prohibited inNode names (.:@/").
Stringxml_escape()
Returns a copy of the string with special characters escaped using the XML standard.
Stringxml_unescape()
Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.