.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the String.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_String: String ====== **Category:** Built-In Types Brief Description ----------------- Built-in string class. Member Functions ---------------- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`c_escape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`c_unescape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`capitalize` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`dedent` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`format` **(** var values, :ref:`String` placeholder={_} **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_base_dir` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_basename` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_extension` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_abs_path` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_rel_path` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_float` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_integer` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`json_escape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`md5_text` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`percent_decode` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`percent_encode` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`sha256_text` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`to_float` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_upper` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`xml_escape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`xml_unescape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 --------------------------- .. _class_String_String: - :ref:`String` **String** **(** :ref:`bool` from **)** Constructs a new String from the given :ref:`bool`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector2` from **)** Constructs a new String from the given :ref:`Vector2`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Plane` from **)** Constructs a new String from the given :ref:`Plane`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Quat` from **)** Constructs a new String from the given :ref:`Quat`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`AABB` from **)** Constructs a new String from the given :ref:`AABB`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Basis` from **)** Constructs a new String from the given :ref:`Basis`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform` from **)** Constructs a new String from the given :ref:`Transform`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Color` from **)** Constructs a new String from the given :ref:`Color`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`RID` from **)** Constructs a new String from the given :ref:`RID`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`Array` from **)** Constructs a new String from the given :ref:`Array`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** Constructs a new String from the given :ref:`PoolByteArray`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** Constructs a new String from the given :ref:`PoolIntArray`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** Constructs a new String from the given :ref:`PoolRealArray`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** Constructs a new String from the given :ref:`PoolStringArray`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** Constructs a new String from the given :ref:`PoolVector2Array`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** Constructs a new String from the given :ref:`PoolVector3Array`. .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** Constructs a new String from the given :ref:`PoolColorArray`. .. _class_String_begins_with: - :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. .. _class_String_bigrams: - :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. .. _class_String_c_escape: - :ref:`String` **c_escape** **(** **)** Returns a copy of the string with special characters escaped using the C language standard. .. _class_String_c_unescape: - :ref:`String` **c_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. .. _class_String_capitalize: - :ref:`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``. .. _class_String_casecmp_to: - :ref:`int` **casecmp_to** **(** :ref:`String` to **)** Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. .. _class_String_dedent: - :ref:`String` **dedent** **(** **)** Removes indentation from string. .. _class_String_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the string is empty. .. _class_String_ends_with: - :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. .. _class_String_erase: - void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erases ``chars`` characters from the string starting from ``position``. .. _class_String_find: - :ref:`int` **find** **(** :ref:`String` what, :ref:`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. .. _class_String_find_last: - :ref:`int` **find_last** **(** :ref:`String` what **)** Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. .. _class_String_findn: - :ref:`int` **findn** **(** :ref:`String` what, :ref:`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. .. _class_String_format: - :ref:`String` **format** **(** var values, :ref:`String` placeholder={_} **)** Formats the string by replacing all occurrences of ``placeholder`` with ``values``. .. _class_String_get_base_dir: - :ref:`String` **get_base_dir** **(** **)** If the string is a valid file path, returns the base directory name. .. _class_String_get_basename: - :ref:`String` **get_basename** **(** **)** If the string is a valid file path, returns the full file path without the extension. .. _class_String_get_extension: - :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. .. _class_String_get_file: - :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. .. _class_String_hash: - :ref:`int` **hash** **(** **)** Hashes the string and returns a 32-bit integer. .. _class_String_hex_to_int: - :ref:`int` **hex_to_int** **(** **)** Converts a string containing a hexadecimal number into an integer. .. _class_String_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. .. _class_String_is_abs_path: - :ref:`bool` **is_abs_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is absolute. .. _class_String_is_rel_path: - :ref:`bool` **is_rel_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is relative. .. _class_String_is_subsequence_of: - :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string. .. _class_String_is_subsequence_ofi: - :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string, without considering case. .. _class_String_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** Returns ``true`` if this string contains a valid float. .. _class_String_is_valid_html_color: - :ref:`bool` **is_valid_html_color** **(** **)** Returns ``true`` if this string contains a valid color in HTML notation. .. _class_String_is_valid_identifier: - :ref:`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. .. _class_String_is_valid_integer: - :ref:`bool` **is_valid_integer** **(** **)** Returns ``true`` if this string contains a valid integer. .. _class_String_is_valid_ip_address: - :ref:`bool` **is_valid_ip_address** **(** **)** Returns ``true`` if this string contains a valid IP address. .. _class_String_json_escape: - :ref:`String` **json_escape** **(** **)** Returns a copy of the string with special characters escaped using the JSON standard. .. _class_String_left: - :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. .. _class_String_length: - :ref:`int` **length** **(** **)** Returns the string's amount of characters. .. _class_String_match: - :ref:`bool` **match** **(** :ref:`String` expr **)** Does a simple expression match, where '\*' matches zero or more arbitrary characters and '?' matches any single character except '.'. .. _class_String_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** Does a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). .. _class_String_md5_buffer: - :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. .. _class_String_md5_text: - :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. .. _class_String_nocasecmp_to: - :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** Performs a case-insensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. .. _class_String_ord_at: - :ref:`int` **ord_at** **(** :ref:`int` at **)** Returns the character code at position ``at``. .. _class_String_pad_decimals: - :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` after the decimal point. .. _class_String_pad_zeros: - :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` before the decimal point. .. _class_String_percent_decode: - :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. .. _class_String_percent_encode: - :ref:`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). .. _class_String_plus_file: - :ref:`String` **plus_file** **(** :ref:`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"``. .. _class_String_replace: - :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. .. _class_String_replacen: - :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. Ignores case. .. _class_String_rfind: - :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. .. _class_String_rfindn: - :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. .. _class_String_right: - :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. .. _class_String_sha256_buffer: - :ref:`PoolByteArray` **sha256_buffer** **(** **)** .. _class_String_sha256_text: - :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. .. _class_String_similarity: - :ref:`float` **similarity** **(** :ref:`String` text **)** Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. .. _class_String_split: - :ref:`PoolStringArray