|
|
@@ -17,6 +17,7 @@
|
|
|
<argument index="0" name="from" type="bool">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [bool].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -25,6 +26,7 @@
|
|
|
<argument index="0" name="from" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [int].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -33,6 +35,7 @@
|
|
|
<argument index="0" name="from" type="float">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [float].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -41,6 +44,7 @@
|
|
|
<argument index="0" name="from" type="Vector2">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Vector2].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -49,6 +53,7 @@
|
|
|
<argument index="0" name="from" type="Rect2">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Rect2].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -57,6 +62,7 @@
|
|
|
<argument index="0" name="from" type="Vector3">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Vector3].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -65,6 +71,7 @@
|
|
|
<argument index="0" name="from" type="Transform2D">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Transform2D].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -73,6 +80,7 @@
|
|
|
<argument index="0" name="from" type="Plane">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Plane].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -81,6 +89,7 @@
|
|
|
<argument index="0" name="from" type="Quat">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Quat].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -89,6 +98,7 @@
|
|
|
<argument index="0" name="from" type="Rect3">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Rect3].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -97,6 +107,7 @@
|
|
|
<argument index="0" name="from" type="Basis">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Basis].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -105,6 +116,7 @@
|
|
|
<argument index="0" name="from" type="Transform">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Transform].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -113,6 +125,7 @@
|
|
|
<argument index="0" name="from" type="Color">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Color].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -121,6 +134,7 @@
|
|
|
<argument index="0" name="from" type="NodePath">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [NodePath].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -129,6 +143,7 @@
|
|
|
<argument index="0" name="from" type="RID">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [RID].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -137,6 +152,7 @@
|
|
|
<argument index="0" name="from" type="Dictionary">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Dictionary].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -145,6 +161,7 @@
|
|
|
<argument index="0" name="from" type="Array">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [Array].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -153,6 +170,7 @@
|
|
|
<argument index="0" name="from" type="PoolByteArray">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolByteArray].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -161,6 +179,7 @@
|
|
|
<argument index="0" name="from" type="PoolIntArray">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolIntArray].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -169,6 +188,7 @@
|
|
|
<argument index="0" name="from" type="PoolRealArray">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolRealArray].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -177,6 +197,7 @@
|
|
|
<argument index="0" name="from" type="PoolStringArray">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolStringArray].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -185,6 +206,7 @@
|
|
|
<argument index="0" name="from" type="PoolVector2Array">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolVector2Array].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -193,6 +215,7 @@
|
|
|
<argument index="0" name="from" type="PoolVector3Array">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolVector3Array].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="String">
|
|
|
@@ -201,6 +224,7 @@
|
|
|
<argument index="0" name="from" type="PoolColorArray">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Constructs a new String from the given [PoolColorArray].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="begins_with">
|
|
|
@@ -209,35 +233,35 @@
|
|
|
<argument index="0" name="text" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return true if the strings begins with the given string.
|
|
|
+ Returns [code]true[/code] if the string begins with the given string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="bigrams">
|
|
|
<return type="PoolStringArray">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the bigrams (pairs of consecutive letters) of this string.
|
|
|
+ Returns the bigrams (pairs of consecutive letters) of this string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="c_escape">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return a copy of the string with special characters escaped using the C language standard.
|
|
|
+ Returns a copy of the string with special characters escaped using the C language standard.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="c_unescape">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return a copy of the string with escaped characters replaced by their meanings according to the C language standard.
|
|
|
+ Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="capitalize">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize 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].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="casecmp_to">
|
|
|
@@ -246,14 +270,14 @@
|
|
|
<argument index="0" name="to" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="empty">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return true if the string is empty.
|
|
|
+ Returns [code]true[/code] if the string is empty.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="ends_with">
|
|
|
@@ -262,7 +286,7 @@
|
|
|
<argument index="0" name="text" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return true if the strings ends with the given string.
|
|
|
+ Returns [code]true[/code] if the string ends with the given string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="erase">
|
|
|
@@ -271,7 +295,7 @@
|
|
|
<argument index="1" name="chars" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Erase [code]chars[/code] characters from the string starting from [code]position[/code].
|
|
|
+ Erases [code]chars[/code] characters from the string starting from [code]position[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="find">
|
|
|
@@ -282,7 +306,7 @@
|
|
|
<argument index="1" name="from" type="int" default="0">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="find_last">
|
|
|
@@ -291,7 +315,7 @@
|
|
|
<argument index="0" name="what" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Find the last occurrence of a substring, return 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. Optionally, the initial search index can be passed.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="findn">
|
|
|
@@ -302,7 +326,7 @@
|
|
|
<argument index="1" name="from" type="int" default="0">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="format">
|
|
|
@@ -313,48 +337,49 @@
|
|
|
<argument index="1" name="placeholder" type="String" default="{_}">
|
|
|
</argument>
|
|
|
<description>
|
|
|
+ Formats the string by replacing all occurences of [code]placeholder[/code] with [code]values[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="get_base_dir">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file, return the base directory.
|
|
|
+ If the string is a valid file path, returns the base directory name.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="get_basename">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file, return the path to the file without the extension.
|
|
|
+ If the string is a valid file path, returns the full file path without the extension.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="get_extension">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file, return the extension.
|
|
|
+ If the string is a valid file path, returns the extension.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="get_file">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file, return the file and ignore the base directory.
|
|
|
+ If the string is a valid file path, returns the filename.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="hash">
|
|
|
<return type="int">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Hash the string and return a 32 bits integer.
|
|
|
+ Hashes the string and returns a 32-bit integer.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="hex_to_int">
|
|
|
<return type="int">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Convert a string containing a hexadecimal number into an int.
|
|
|
+ Converts a string containing a hexadecimal number into an integer.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="insert">
|
|
|
@@ -365,21 +390,21 @@
|
|
|
<argument index="1" name="what" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Insert a substring at a given position.
|
|
|
+ Inserts a substring at a given position.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_abs_path">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file or directory, return true if the path is absolute.
|
|
|
+ If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_rel_path">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- If the string is a path to a file or directory, return true if the path is relative.
|
|
|
+ If the string is a path to a file or directory, returns [code]true[/code] if the path is relative.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_subsequence_of">
|
|
|
@@ -388,7 +413,7 @@
|
|
|
<argument index="0" name="text" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Check whether this string is a subsequence of the given string.
|
|
|
+ Returns [code]true[/code] if this string is a subsequence of the given string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_subsequence_ofi">
|
|
|
@@ -397,49 +422,49 @@
|
|
|
<argument index="0" name="text" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Check whether this string is a subsequence of the given string, without considering case.
|
|
|
+ Returns [code]true[/code] if this string is a subsequence of the given string, without considering case.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_valid_float">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Check whether the string contains a valid float.
|
|
|
+ Returns [code]true[/code] if this string contains a valid float.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_valid_html_color">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Check whether the string contains a valid color in HTML notation.
|
|
|
+ Returns [code]true[/code] if this string contains a valid color in HTML notation.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_valid_identifier">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit.
|
|
|
+ Returns [code]true[/code] 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_valid_integer">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Check whether the string contains a valid integer.
|
|
|
+ Returns [code]true[/code] if this string contains a valid integer.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_valid_ip_address">
|
|
|
<return type="bool">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Check whether the string contains a valid IP address.
|
|
|
+ Returns [code]true[/code] if this string contains a valid IP address.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="json_escape">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return a copy of the string with special characters escaped using the JSON standard.
|
|
|
+ Returns a copy of the string with special characters escaped using the JSON standard.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="left">
|
|
|
@@ -448,14 +473,14 @@
|
|
|
<argument index="0" name="position" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return an amount of characters from the left of the string.
|
|
|
+ Returns a number of characters from the left of the string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="length">
|
|
|
<return type="int">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the length of the string in characters.
|
|
|
+ Returns the string's amount of characters.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="match">
|
|
|
@@ -464,7 +489,7 @@
|
|
|
<argument index="0" name="expr" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'.
|
|
|
+ Does a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="matchn">
|
|
|
@@ -473,21 +498,21 @@
|
|
|
<argument index="0" name="expr" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Do a simple case insensitive expression match, using ? and * wildcards (see [method match]).
|
|
|
+ Does a simple case insensitive expression match, using ? and * wildcards (see [method match]).
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="md5_buffer">
|
|
|
<return type="PoolByteArray">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the MD5 hash of the string as an array of bytes.
|
|
|
+ Returns the MD5 hash of the string as an array of bytes.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="md5_text">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the MD5 hash of the string as a string.
|
|
|
+ Returns the MD5 hash of the string as a string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="nocasecmp_to">
|
|
|
@@ -496,7 +521,7 @@
|
|
|
<argument index="0" name="to" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="ord_at">
|
|
|
@@ -505,7 +530,7 @@
|
|
|
<argument index="0" name="at" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return the character code at position [code]at[/code].
|
|
|
+ Returns the character code at position [code]at[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="pad_decimals">
|
|
|
@@ -514,7 +539,7 @@
|
|
|
<argument index="0" name="digits" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Format a number to have an exact number of [code]digits[/code] after the decimal point.
|
|
|
+ Formats a number to have an exact number of [code]digits[/code] after the decimal point.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="pad_zeros">
|
|
|
@@ -523,7 +548,7 @@
|
|
|
<argument index="0" name="digits" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Format a number to have an exact number of [code]digits[/code] before the decimal point.
|
|
|
+ Formats a number to have an exact number of [code]digits[/code] before the decimal point.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="percent_decode">
|
|
|
@@ -537,7 +562,7 @@
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request.
|
|
|
+ Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests).
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="plus_file">
|
|
|
@@ -557,7 +582,7 @@
|
|
|
<argument index="1" name="forwhat" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Replace occurrences of a substring for different ones inside the string.
|
|
|
+ Replaces occurrences of a substring with the given one inside the string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="replacen">
|
|
|
@@ -568,7 +593,7 @@
|
|
|
<argument index="1" name="forwhat" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Replace occurrences of a substring for different ones inside the string, but search case-insensitive.
|
|
|
+ Replaces occurrences of a substring with the given one inside the string. Ignores case.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="rfind">
|
|
|
@@ -579,7 +604,7 @@
|
|
|
<argument index="1" name="from" type="int" default="-1">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Perform a search for a substring, but start from the end of the string instead of the beginning.
|
|
|
+ Performs a search for a substring, but starts from the end of the string instead of the beginning.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="rfindn">
|
|
|
@@ -590,7 +615,7 @@
|
|
|
<argument index="1" name="from" type="int" default="-1">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive.
|
|
|
+ Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="right">
|
|
|
@@ -599,7 +624,7 @@
|
|
|
<argument index="0" name="position" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return the right side of the string from a given position.
|
|
|
+ Returns the right side of the string from a given position.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="sha256_buffer">
|
|
|
@@ -612,7 +637,7 @@
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the SHA-256 hash of the string as a string.
|
|
|
+ Returns the SHA-256 hash of the string as a string.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="similarity">
|
|
|
@@ -621,7 +646,7 @@
|
|
|
<argument index="0" name="text" type="String">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
|
|
|
+ Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="split">
|
|
|
@@ -632,7 +657,7 @@
|
|
|
<argument index="1" name="allow_empty" type="bool" default="True">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".
|
|
|
+ Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="split_floats">
|
|
|
@@ -643,7 +668,7 @@
|
|
|
<argument index="1" name="allow_empty" type="bool" default="True">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",".
|
|
|
+ Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",".
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="strip_edges">
|
|
|
@@ -654,7 +679,7 @@
|
|
|
<argument index="1" name="right" type="bool" default="True">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.
|
|
|
+ Returns 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="substr">
|
|
|
@@ -665,63 +690,63 @@
|
|
|
<argument index="1" name="len" type="int">
|
|
|
</argument>
|
|
|
<description>
|
|
|
- Return part of the string from the position [code]from[/code], with length [code]len[/code].
|
|
|
+ Returns part of the string from the position [code]from[/code] with length [code]len[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_ascii">
|
|
|
<return type="PoolByteArray">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters.
|
|
|
+ Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is sped up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_float">
|
|
|
<return type="float">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Convert a string, containing a decimal number, into a [code]float[/code].
|
|
|
+ Converts a string containing a decimal number into a [code]float[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_int">
|
|
|
<return type="int">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Convert a string, containing an integer number, into an [code]int[/code].
|
|
|
+ Converts a string containing an integer number into an [code]int[/code].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_lower">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the string converted to lowercase.
|
|
|
+ Returns the string converted to lowercase.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_upper">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return the string converted to uppercase.
|
|
|
+ Returns the string converted to uppercase.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="to_utf8">
|
|
|
<return type="PoolByteArray">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Convert 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().
|
|
|
+ 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().
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="xml_escape">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return a copy of the string with special characters escaped using the XML standard.
|
|
|
+ Returns a copy of the string with special characters escaped using the XML standard.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="xml_unescape">
|
|
|
<return type="String">
|
|
|
</return>
|
|
|
<description>
|
|
|
- Return a copy of the string with escaped characters replaced by their meanings according to the XML standard.
|
|
|
+ Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.
|
|
|
</description>
|
|
|
</method>
|
|
|
</methods>
|
mhilbrunner