2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "String" category= "Built-In Types" version= "3.1.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
Built-in string class.
</brief_description>
<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.
</description>
<tutorials >
</tutorials>
<methods >
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "bool" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [bool].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [int].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "float" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [float].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Vector2" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Vector2].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Rect2" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Rect2].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Vector3" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Vector3].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Transform2D" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Transform2D].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Plane" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Plane].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Quat" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Quat].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
2017-11-17 02:09:00 +00:00
<argument index= "0" name= "from" type= "AABB" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2017-11-17 02:09:00 +00:00
Constructs a new String from the given [AABB].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Basis" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Basis].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Transform" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Transform].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Color" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Color].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "NodePath" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [NodePath].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "RID" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [RID].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Dictionary" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Dictionary].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "Array" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [Array].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolByteArray" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolByteArray].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolIntArray" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolIntArray].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolRealArray" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolRealArray].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolStringArray" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolStringArray].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolVector2Array" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolVector2Array].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolVector3Array" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolVector3Array].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "String" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "PoolColorArray" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Constructs a new String from the given [PoolColorArray].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "begins_with" >
<return type= "bool" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if the string begins with the given string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "bigrams" >
<return type= "PoolStringArray" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the bigrams (pairs of consecutive letters) of this string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "c_escape" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns a copy of the string with special characters escaped using the C language standard.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "c_unescape" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "capitalize" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
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 [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "casecmp_to" >
<return type= "int" >
</return>
<argument index= "0" name= "to" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal.
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-11-13 08:24:36 +00:00
<method name= "dedent" >
<return type= "String" >
</return>
<description >
2018-01-18 18:27:38 +00:00
Removes indentation from string.
2017-11-13 08:24:36 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "empty" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if the string is empty.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "ends_with" >
<return type= "bool" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if the string ends with the given string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "erase" >
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "chars" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Erases [code]chars[/code] characters from the string starting from [code]position[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "find" >
<return type= "int" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "from" type= "int" default= "0" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "find_last" >
<return type= "int" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<description >
2018-01-19 02:10:33 +00:00
Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "findn" >
<return type= "int" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "from" type= "int" default= "0" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "format" >
<return type= "String" >
</return>
2018-08-31 20:38:28 +00:00
<argument index= "0" name= "values" type= "Variant" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "placeholder" type= "String" default= "{_}" >
</argument>
<description >
2018-01-18 20:37:17 +00:00
Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_base_dir" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a valid file path, returns the base directory name.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_basename" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a valid file path, returns the full file path without the extension.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_extension" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a valid file path, returns the extension.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_file" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a valid file path, returns the filename.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hash" >
<return type= "int" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Hashes the string and returns a 32-bit integer.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "hex_to_int" >
<return type= "int" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Converts a string containing a hexadecimal number into an integer.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "insert" >
<return type= "String" >
</return>
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "what" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Inserts a substring at a given position.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_abs_path" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_rel_path" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
If the string is a path to a file or directory, returns [code]true[/code] if the path is relative.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_subsequence_of" >
<return type= "bool" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string is a subsequence of the given string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_subsequence_ofi" >
<return type= "bool" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string is a subsequence of the given string, without considering case.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_valid_float" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string contains a valid float.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-12-24 18:54:36 +00:00
<method name= "is_valid_hex_number" >
<return type= "bool" >
</return>
<argument index= "0" name= "with_prefix" type= "bool" default= "False" >
</argument>
<description >
Returns [code]true[/code] if this string contains a valid hexadecimal number. If [code]with_prefix[/code] is [code]true[/code], then a validity of the hexadecimal number is determined by [code]0x[/code] prefix, for instance: [code]0xDEADC0DE[/code].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "is_valid_html_color" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string contains a valid color in HTML notation.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_valid_identifier" >
<return type= "bool" >
</return>
<description >
2019-01-07 09:02:04 +00:00
Returns [code]true[/code] if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores ([code]_[/code]) and the first character may not be a digit.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_valid_integer" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string contains a valid integer.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_valid_ip_address" >
<return type= "bool" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns [code]true[/code] if this string contains a valid IP address.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "json_escape" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns a copy of the string with special characters escaped using the JSON standard.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "left" >
<return type= "String" >
</return>
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns a number of characters from the left of the string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "length" >
<return type= "int" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the string's amount of characters.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-13 14:40:27 +00:00
<method name= "lstrip" >
<return type= "String" >
</return>
<argument index= "0" name= "chars" type= "String" >
</argument>
<description >
Returns a copy of the string with characters removed from the left.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "match" >
<return type= "bool" >
</return>
<argument index= "0" name= "expr" type= "String" >
</argument>
<description >
2019-01-07 09:02:04 +00:00
Does a simple expression match, where [code]*[/code] matches zero or more arbitrary characters and [code]?[/code] matches any single character except '.'.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "matchn" >
<return type= "bool" >
</return>
<argument index= "0" name= "expr" type= "String" >
</argument>
<description >
2019-01-07 09:02:04 +00:00
Does a simple case insensitive expression match, using [code]?[/code] and [code]*[/code] wildcards (see [method match]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "md5_buffer" >
<return type= "PoolByteArray" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the MD5 hash of the string as an array of bytes.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "md5_text" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the MD5 hash of the string as a string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "nocasecmp_to" >
<return type= "int" >
</return>
<argument index= "0" name= "to" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "ord_at" >
<return type= "int" >
</return>
<argument index= "0" name= "at" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns the character code at position [code]at[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pad_decimals" >
<return type= "String" >
</return>
<argument index= "0" name= "digits" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Formats a number to have an exact number of [code]digits[/code] after the decimal point.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pad_zeros" >
<return type= "String" >
</return>
<argument index= "0" name= "digits" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Formats a number to have an exact number of [code]digits[/code] before the decimal point.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "percent_decode" >
<return type= "String" >
</return>
<description >
Decode a percent-encoded string. See [method percent_encode].
</description>
</method>
<method name= "percent_encode" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "plus_file" >
<return type= "String" >
</return>
<argument index= "0" name= "file" type= "String" >
</argument>
<description >
If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code].
</description>
</method>
<method name= "replace" >
<return type= "String" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "forwhat" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Replaces occurrences of a substring with the given one inside the string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "replacen" >
<return type= "String" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "forwhat" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Replaces occurrences of a substring with the given one inside the string. Ignores case.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "rfind" >
<return type= "int" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "from" type= "int" default= "-1" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Performs a search for a substring, but starts from the end of the string instead of the beginning.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "rfindn" >
<return type= "int" >
</return>
<argument index= "0" name= "what" type= "String" >
</argument>
<argument index= "1" name= "from" type= "int" default= "-1" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "right" >
<return type= "String" >
</return>
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns the right side of the string from a given position.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-28 12:53:15 +00:00
<method name= "rsplit" >
<return type= "PoolStringArray" >
</return>
<argument index= "0" name= "divisor" type= "String" >
</argument>
<argument index= "1" name= "allow_empty" type= "bool" default= "True" >
</argument>
<argument index= "2" name= "maxsplit" type= "int" default= "0" >
</argument>
<description >
2018-07-28 20:44:58 +00:00
Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right.
2019-01-07 09:02:04 +00:00
[b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two","Three"][/code] if split by [code]","[/code].
2018-05-28 12:53:15 +00:00
If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items.
</description>
</method>
2018-04-13 14:40:27 +00:00
<method name= "rstrip" >
<return type= "String" >
</return>
<argument index= "0" name= "chars" type= "String" >
</argument>
<description >
Returns a copy of the string with characters removed from the right.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "sha256_buffer" >
<return type= "PoolByteArray" >
</return>
<description >
2018-10-11 17:28:36 +00:00
Returns the SHA-256 hash of the string as an array of bytes.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "sha256_text" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the SHA-256 hash of the string as a string.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "similarity" >
<return type= "float" >
</return>
<argument index= "0" name= "text" type= "String" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "split" >
<return type= "PoolStringArray" >
</return>
<argument index= "0" name= "divisor" type= "String" >
</argument>
<argument index= "1" name= "allow_empty" type= "bool" default= "True" >
</argument>
2017-12-12 02:14:38 +00:00
<argument index= "2" name= "maxsplit" type= "int" default= "0" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2018-07-28 20:44:58 +00:00
Splits the string by a divisor string and returns an array of the substrings.
2019-01-07 09:02:04 +00:00
[b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two","Three"][/code] if split by [code]","[/code].
2017-12-12 02:14:38 +00:00
If [code]maxsplit[/code] 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)
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "split_floats" >
<return type= "PoolRealArray" >
</return>
<argument index= "0" name= "divisor" type= "String" >
</argument>
<argument index= "1" name= "allow_empty" type= "bool" default= "True" >
</argument>
<description >
2018-07-28 20:44:58 +00:00
Splits the string in floats by using a divisor string and returns an array of the substrings.
2019-01-07 09:02:04 +00:00
[b]Example:[/b] [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "strip_edges" >
<return type= "String" >
</return>
<argument index= "0" name= "left" type= "bool" default= "True" >
</argument>
<argument index= "1" name= "right" type= "bool" default= "True" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "substr" >
<return type= "String" >
</return>
<argument index= "0" name= "from" type= "int" >
</argument>
<argument index= "1" name= "len" type= "int" >
</argument>
<description >
2017-10-22 20:55:21 +00:00
Returns part of the string from the position [code]from[/code] with length [code]len[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_ascii" >
<return type= "PoolByteArray" >
</return>
<description >
2019-01-07 09:02:04 +00:00
Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is sped up in comparison to [method to_utf8] with the assumption that all the characters the String contains are only ASCII characters.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_float" >
<return type= "float" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Converts a string containing a decimal number into a [code]float[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_int" >
<return type= "int" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Converts a string containing an integer number into an [code]int[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_lower" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the string converted to lowercase.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_upper" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns the string converted to uppercase.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "to_utf8" >
<return type= "PoolByteArray" >
</return>
<description >
2019-01-07 09:02:04 +00:00
Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-13 14:40:27 +00:00
<method name= "trim_prefix" >
<return type= "String" >
</return>
<argument index= "0" name= "prefix" type= "String" >
</argument>
<description >
Removes a given string from the start if it starts with it or leaves the string unchanged.
</description>
</method>
<method name= "trim_suffix" >
<return type= "String" >
</return>
<argument index= "0" name= "suffix" type= "String" >
</argument>
<description >
Removes a given string from the end if it ends with it or leaves the string unchanged.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "xml_escape" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns a copy of the string with special characters escaped using the XML standard.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "xml_unescape" >
<return type= "String" >
</return>
<description >
2017-10-22 20:55:21 +00:00
Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>