Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?

String

0 0 vote
Article Rating

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.

Methods

StringString ( bool from )
StringString ( int from )
StringString ( float from )
StringString ( Vector2 from )
StringString ( Rect2 from )
StringString ( Vector3 from )
StringString ( Transform2D from )
StringString ( Plane from )
StringString ( Quat from )
StringString ( AABB from )
StringString ( Basis from )
StringString ( Transform from )
StringString ( Color from )
StringString ( NodePath from )
StringString ( RID from )
StringString ( Dictionary from )
StringString ( Array from )
StringString ( PoolByteArray from )
StringString ( PoolIntArray from )
StringString ( PoolRealArray from )
StringString ( PoolStringArray from )
StringString ( PoolVector2Array from )
StringString ( PoolVector3Array from )
StringString ( PoolColorArray from )
boolbegins_with ( String text )
PoolStringArraybigrams ( )
Stringc_escape ( )
Stringc_unescape ( )
Stringcapitalize ( )
intcasecmp_to ( String to )
intcount ( String what, int from=0, int to=0 )
intcountn ( String what, int from=0, int to=0 )
Stringdedent ( )
boolempty ( )
boolends_with ( String text )
voiderase ( int position, int chars )
intfind ( String what, int from=0 )
intfind_last ( String what )
intfindn ( String what, int from=0 )
Stringformat ( Variant values, String placeholder={_} )
Stringget_base_dir ( )
Stringget_basename ( )
Stringget_extension ( )
Stringget_file ( )
inthash ( )
inthex_to_int ( )
Stringhttp_escape ( )
Stringhttp_unescape ( )
Stringhumanize_size ( int size )
Stringinsert ( int position, String what )
boolis_abs_path ( )
boolis_rel_path ( )
boolis_subsequence_of ( String text )
boolis_subsequence_ofi ( String text )
boolis_valid_filename ( )
boolis_valid_float ( )
boolis_valid_hex_number ( bool with_prefix=False )
boolis_valid_html_color ( )
boolis_valid_identifier ( )
boolis_valid_integer ( )
boolis_valid_ip_address ( )
Stringjson_escape ( )
Stringleft ( int position )
intlength ( )
Stringlstrip ( String chars )
boolmatch ( String expr )
boolmatchn ( String expr )
PoolByteArraymd5_buffer ( )
Stringmd5_text ( )
intnocasecmp_to ( String to )
intord_at ( int at )
Stringpad_decimals ( int digits )
Stringpad_zeros ( int digits )
Stringpercent_decode ( )
Stringpercent_encode ( )
Stringplus_file ( String file )
Stringrepeat ( int count )
Stringreplace ( String what, String forwhat )
Stringreplacen ( String what, String forwhat )
intrfind ( String what, int from=-1 )
intrfindn ( String what, int from=-1 )
Stringright ( int position )
PoolStringArrayrsplit ( String delimiter, bool allow_empty=True, int maxsplit=0 )
Stringrstrip ( String chars )
PoolByteArraysha1_buffer ( )
Stringsha1_text ( )
PoolByteArraysha256_buffer ( )
Stringsha256_text ( )
floatsimilarity ( String text )
PoolStringArraysplit ( String delimiter, bool allow_empty=True, int maxsplit=0 )
PoolRealArraysplit_floats ( String delimiter, bool allow_empty=True )
Stringstrip_edges ( bool left=True, bool right=True )
Stringstrip_escapes ( )
Stringsubstr ( int from, int len=-1 )
PoolByteArrayto_ascii ( )
floatto_float ( )
intto_int ( )
Stringto_lower ( )
Stringto_upper ( )
PoolByteArrayto_utf8 ( )
Stringtrim_prefix ( String prefix )
Stringtrim_suffix ( String suffix )
Stringxml_escape ( )
Stringxml_unescape ( )

Method Descriptions

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.


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.


Constructs a new String from the given Dictionary.


Constructs a new String from the given Array.


Constructs a new String from the given PoolByteArray.


Constructs a new String from the given PoolIntArray.


Constructs a new String from the given PoolRealArray.


Constructs a new String from the given PoolStringArray.


Constructs a new String from the given PoolVector2Array.


Constructs a new String from the given PoolVector3Array.


Constructs a new String from the given PoolColorArray.


Returns true if the string begins with the given string.


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


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


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.


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.


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.


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


Returns true if the string is empty.


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.


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.


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 path, returns the extension.


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


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"

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

print("https://example.org/?escaped=" + "Godot Engine:'docs'".http_escape())

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())

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.

var bytes = 133790307
var size = String.humanize_size(bytes)
print(size) # prints "127.5 MiB"

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.


  • 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_filename ( )

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

: / ? * " | % < >


  • 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 hexadecimal HTML notation. Other HTML notations such as named colors or hsl() colors aren’t considered valid by this method and will return false.


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


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.


Returns the string’s amount of characters.


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


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


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


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


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.


Decode a percent-encoded string. See 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".


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.


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"

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


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


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


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


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.


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"

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.


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 position from with length len. Argument len is optional and using -1 will return remaining characters from given position.


Converts the String (which is a character array) to PoolByteArray (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.


Converts a string containing a decimal number into a float.


Converts a string containing an integer number into an int.


Returns the string converted to lowercase.


Returns the string converted to uppercase.


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.


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.


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


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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x