diff options
Diffstat (limited to 'doc/classes/String.xml')
| -rw-r--r-- | doc/classes/String.xml | 1192 |
1 files changed, 494 insertions, 698 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 0dd6923129..97efc24bd1 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -4,1022 +4,818 @@ 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. + 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> - <link>https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_format_string.html</link> + <link title="GDScript format strings">https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_format_string.html</link> </tutorials> <methods> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="bool"> - </argument> + <method name="String" qualifiers="constructor"> + <return type="String" /> <description> - Constructs a new String from the given [bool]. + Constructs an empty [String] ([code]""[/code]). </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="int"> - </argument> + <method name="String" qualifiers="constructor"> + <return type="String" /> + <argument index="0" name="from" type="String" /> <description> - Constructs a new String from the given [int]. + Constructs a [String] as a copy of the given [String]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="float"> - </argument> - <description> - Constructs a new String from the given [float]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Vector2"> - </argument> - <description> - Constructs a new String from the given [Vector2]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Vector2i"> - </argument> - <description> - Constructs a new String from the given [Vector2i]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Rect2"> - </argument> - <description> - Constructs a new String from the given [Rect2]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Rect2i"> - </argument> - <description> - Constructs a new String from the given [Rect2i]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Vector3"> - </argument> - <description> - Constructs a new String from the given [Vector3]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Vector3i"> - </argument> - <description> - Constructs a new String from the given [Vector3i]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Transform2D"> - </argument> - <description> - Constructs a new String from the given [Transform2D]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Plane"> - </argument> - <description> - Constructs a new String from the given [Plane]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Quat"> - </argument> - <description> - Constructs a new String from the given [Quat]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="AABB"> - </argument> - <description> - Constructs a new String from the given [AABB]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Basis"> - </argument> - <description> - Constructs a new String from the given [Basis]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Transform"> - </argument> - <description> - Constructs a new String from the given [Transform]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Color"> - </argument> - <description> - Constructs a new String from the given [Color]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="StringName"> - </argument> - <description> - Constructs a new String from the given [StringName]. - </description> - </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="NodePath"> - </argument> + <method name="String" qualifiers="constructor"> + <return type="String" /> + <argument index="0" name="from" type="NodePath" /> <description> Constructs a new String from the given [NodePath]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="RID"> - </argument> + <method name="String" qualifiers="constructor"> + <return type="String" /> + <argument index="0" name="from" type="StringName" /> <description> - Constructs a new String from the given [RID]. + Constructs a new String from the given [StringName]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Callable"> - </argument> + <method name="begins_with" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> <description> - Constructs a new String from the given [Callable]. + Returns [code]true[/code] if the string begins with the given string. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Signal"> - </argument> + <method name="bigrams" qualifiers="const"> + <return type="PackedStringArray" /> <description> - Constructs a new String from the given [Signal]. + Returns the bigrams (pairs of consecutive letters) of this string. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Dictionary"> - </argument> + <method name="bin_to_int" qualifiers="const"> + <return type="int" /> <description> - Constructs a new String from the given [Dictionary]. + Converts a string containing a binary number into an integer. Binary strings can either be prefixed with [code]0b[/code] or not, and they can also start with a [code]-[/code] before the optional prefix. + [codeblocks] + [gdscript] + print("0x101".bin_to_int()) # Prints "5". + print("101".bin_to_int()) # Prints "5". + [/gdscript] + [csharp] + GD.Print("0x101".BinToInt()); // Prints "5". + GD.Print("101".BinToInt()); // Prints "5". + [/csharp] + [/codeblocks] </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="Array"> - </argument> + <method name="c_escape" qualifiers="const"> + <return type="String" /> <description> - Constructs a new String from the given [Array]. + Returns a copy of the string with special characters escaped using the C language standard. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedByteArray"> - </argument> + <method name="c_unescape" qualifiers="const"> + <return type="String" /> <description> - Constructs a new String from the given [PackedByteArray]. + Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are [code]\'[/code], [code]\"[/code], [code]\?[/code], [code]\\[/code], [code]\a[/code], [code]\b[/code], [code]\f[/code], [code]\n[/code], [code]\r[/code], [code]\t[/code], [code]\v[/code]. + [b]Note:[/b] Unlike the GDScript parser, this method doesn't support the [code]\uXXXX[/code] escape sequence. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedInt32Array"> - </argument> + <method name="capitalize" qualifiers="const"> + <return type="String" /> <description> - Constructs a new String from the given [PackedInt32Array]. + Changes the case of some letters. Replaces underscores with spaces, adds spaces before in-word uppercase characters, converts all letters to lowercase, then capitalizes the first letter and every letter following a space character. For [code]capitalize camelCase mixed_with_underscores[/code], it will return [code]Capitalize Camel Case Mixed With Underscores[/code]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedInt64Array"> - </argument> + <method name="casecmp_to" qualifiers="const"> + <return type="int" /> + <argument index="0" name="to" type="String" /> <description> - Constructs a new String from the given [PackedInt64Array]. + 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. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. + [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. + [b]Behavior with empty strings:[/b] Returns [code]-1[/code] if the "base" string is empty, [code]1[/code] if the [code]to[/code] string is empty or [code]0[/code] if both strings are empty. + To get a boolean result from a string comparison, use the [code]==[/code] operator instead. See also [method nocasecmp_to] and [method naturalnocasecmp_to]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedFloat32Array"> - </argument> + <method name="chr" qualifiers="static"> + <return type="String" /> + <argument index="0" name="char" type="int" /> <description> - Constructs a new String from the given [PackedFloat32Array]. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedFloat64Array"> - </argument> + <method name="count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="0" /> + <argument index="2" name="to" type="int" default="0" /> <description> - Constructs a new String from the given [PackedFloat64Array]. + Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedStringArray"> - </argument> + <method name="countn" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="0" /> + <argument index="2" name="to" type="int" default="0" /> <description> - Constructs a new String from the given [PackedStringArray]. + Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedVector2Array"> - </argument> + <method name="dedent" qualifiers="const"> + <return type="String" /> <description> - Constructs a new String from the given [PackedVector2Array]. + Returns a copy of the string with indentation (leading tabs and spaces) removed. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedVector3Array"> - </argument> + <method name="ends_with" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> <description> - Constructs a new String from the given [PackedVector3Array]. + Returns [code]true[/code] if the string ends with the given string. </description> </method> - <method name="String"> - <return type="String"> - </return> - <argument index="0" name="from" type="PackedColorArray"> - </argument> + <method name="find" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="0" /> <description> - Constructs a new String from the given [PackedColorArray]. + Returns the index of the [b]first[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. + [b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows: + [codeblocks] + [gdscript] + print("i" in "team") # Will print `false`. + [/gdscript] + [csharp] + // C# has no in operator, but we can use `Contains()`. + GD.Print("team".Contains("i")); // Will print `false`. + [/csharp] + [/codeblocks] </description> </method> - <method name="begins_with"> - <return type="bool"> - </return> - <argument index="0" name="text" type="String"> - </argument> + <method name="findn" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="0" /> <description> - Returns [code]true[/code] if the string begins with the given string. + Returns the index of the [b]first[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. </description> </method> - <method name="bigrams"> - <return type="PackedStringArray"> - </return> + <method name="format" qualifiers="const"> + <return type="String" /> + <argument index="0" name="values" type="Variant" /> + <argument index="1" name="placeholder" type="String" default=""{_}"" /> <description> - Returns the bigrams (pairs of consecutive letters) of this string. + Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code]. </description> </method> - <method name="c_escape"> - <return type="String"> - </return> + <method name="get_base_dir" qualifiers="const"> + <return type="String" /> <description> - Returns a copy of the string with special characters escaped using the C language standard. + If the string is a valid file path, returns the base directory name. </description> </method> - <method name="c_unescape"> - <return type="String"> - </return> + <method name="get_basename" qualifiers="const"> + <return type="String" /> <description> - Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. + If the string is a valid file path, returns the full file path without the extension. </description> </method> - <method name="capitalize"> - <return type="String"> - </return> + <method name="get_extension" qualifiers="const"> + <return type="String" /> <description> - 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]. + Returns the extension without the leading period character ([code].[/code]) if the string is a valid file name or path. If the string does not contain an extension, returns an empty string instead. + [codeblock] + print("/path/to/file.txt".get_extension()) # "txt" + print("file.txt".get_extension()) # "txt" + print("file.sample.txt".get_extension()) # "txt" + print(".txt".get_extension()) # "txt" + print("file.txt.".get_extension()) # "" (empty string) + print("file.txt..".get_extension()) # "" (empty string) + print("txt".get_extension()) # "" (empty string) + print("".get_extension()) # "" (empty string) + [/codeblock] </description> </method> - <method name="casecmp_to"> - <return type="int"> - </return> - <argument index="0" name="to" type="String"> - </argument> + <method name="get_file" qualifiers="const"> + <return type="String" /> <description> - 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. + If the string is a valid file path, returns the filename. </description> </method> - <method name="count"> - <return type="int"> - </return> - <argument index="0" name="what" type="String"> - </argument> - <argument index="1" name="from" type="int" default="0"> - </argument> - <argument index="2" name="to" type="int" default="0"> - </argument> + <method name="hash" qualifiers="const"> + <return type="int" /> <description> - Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. + Hashes the string and returns a 32-bit integer. </description> </method> - <method name="countn"> - <return type="int"> - </return> - <argument index="0" name="what" type="String"> - </argument> - <argument index="1" name="from" type="int" default="0"> - </argument> - <argument index="2" name="to" type="int" default="0"> - </argument> + <method name="hex_to_int" qualifiers="const"> + <return type="int" /> <description> - Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. + Converts a string containing a hexadecimal number into an integer. Hexadecimal strings can either be prefixed with [code]0x[/code] or not, and they can also start with a [code]-[/code] before the optional prefix. + [codeblocks] + [gdscript] + print("0xff".hex_to_int()) # Prints "255". + print("ab".hex_to_int()) # Prints "171". + [/gdscript] + [csharp] + GD.Print("0xff".HexToInt()); // Prints "255". + GD.Print("ab".HexToInt()); // Prints "171". + [/csharp] + [/codeblocks] </description> </method> - <method name="dedent"> - <return type="String"> - </return> + <method name="humanize_size" qualifiers="static"> + <return type="String" /> + <argument index="0" name="size" type="int" /> <description> - Returns a copy of the string with indentation (leading tabs and spaces) removed. </description> </method> - <method name="empty"> - <return type="bool"> - </return> + <method name="insert" qualifiers="const"> + <return type="String" /> + <argument index="0" name="position" type="int" /> + <argument index="1" name="what" type="String" /> <description> - Returns [code]true[/code] if the string is empty. + Returns a copy of the string with the substring [code]what[/code] inserted at the given position. </description> </method> - <method name="ends_with"> - <return type="bool"> - </return> - <argument index="0" name="text" type="String"> - </argument> + <method name="is_absolute_path" qualifiers="const"> + <return type="bool" /> <description> - Returns [code]true[/code] if the string ends with the given string. + If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute. </description> </method> - <method name="erase"> - <return type="void"> - </return> - <argument index="0" name="position" type="int"> - </argument> - <argument index="1" name="chars" type="int"> - </argument> + <method name="is_empty" qualifiers="const"> + <return type="bool" /> <description> - Erases [code]chars[/code] characters from the string starting from [code]position[/code]. + Returns [code]true[/code] if the length of the string equals [code]0[/code]. </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> + <method name="is_rel_path" qualifiers="const"> + <return type="bool" /> <description> - 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. + If the string is a path to a file or directory, returns [code]true[/code] if the path is relative. </description> </method> - <method name="find_last"> - <return type="int"> - </return> - <argument index="0" name="what" type="String"> - </argument> + <method name="is_subsequence_of" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> <description> - Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. + Returns [code]true[/code] if this string is a subsequence of the given string. </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> + <method name="is_subsequence_ofi" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> <description> - 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. + Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. </description> </method> - <method name="format"> - <return type="String"> - </return> - <argument index="0" name="values" type="Variant"> - </argument> - <argument index="1" name="placeholder" type="String" default=""{_}""> - </argument> + <method name="is_valid_filename" qualifiers="const"> + <return type="bool" /> <description> - Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code]. + Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being: + [code]: / \ ? * " | % < >[/code] </description> </method> - <method name="get_base_dir"> - <return type="String"> - </return> + <method name="is_valid_float" qualifiers="const"> + <return type="bool" /> <description> - If the string is a valid file path, returns the base directory name. + Returns [code]true[/code] if this string contains a valid float. </description> </method> - <method name="get_basename"> - <return type="String"> - </return> + <method name="is_valid_hex_number" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="with_prefix" type="bool" default="false" /> <description> - If the string is a valid file path, returns the full file path without the extension. + 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> - <method name="get_extension"> - <return type="String"> - </return> + <method name="is_valid_html_color" qualifiers="const"> + <return type="bool" /> <description> - If the string is a valid file path, returns the extension. + Returns [code]true[/code] if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or [code]hsl()[/code] colors aren't considered valid by this method and will return [code]false[/code]. </description> </method> - <method name="get_file"> - <return type="String"> - </return> + <method name="is_valid_identifier" qualifiers="const"> + <return type="bool" /> <description> - If the string is a valid file path, returns the filename. + 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. </description> </method> - <method name="hash"> - <return type="int"> - </return> + <method name="is_valid_int" qualifiers="const"> + <return type="bool" /> <description> - Hashes the string and returns a 32-bit integer. + Returns [code]true[/code] if this string contains a valid integer. </description> </method> - <method name="hex_to_int"> - <return type="int"> - </return> + <method name="is_valid_ip_address" qualifiers="const"> + <return type="bool" /> <description> - Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "[code]0x[/code]" otherwise [code]0[/code] is returned. - [codeblock] - print("0xff".hex_to_int()) # Print "255" - [/codeblock] + Returns [code]true[/code] if this string contains only a well-formatted IPv4 or IPv6 address. This method considers [url=https://en.wikipedia.org/wiki/Reserved_IP_addresses]reserved IP addresses[/url] such as [code]0.0.0.0[/code] as valid. </description> </method> - <method name="http_escape"> - <return type="String"> - </return> + <method name="join" qualifiers="const"> + <return type="String" /> + <argument index="0" name="parts" type="PackedStringArray" /> <description> - Escapes (encodes) a string to URL friendly format. Also referred to as 'URL encode'. - [codeblock] - print("https://example.org/?escaped=" + "Godot Engine:'docs'".http_escape()) - [/codeblock] + Return a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. + Example: + [codeblocks] + [gdscript] + print(", ".join(["One", "Two", "Three", "Four"])) + [/gdscript] + [csharp] + GD.Print(String.Join(",", new string[] {"One", "Two", "Three", "Four"})); + [/csharp] + [/codeblocks] </description> </method> - <method name="http_unescape"> - <return type="String"> - </return> + <method name="json_escape" qualifiers="const"> + <return type="String" /> <description> - Unescapes (decodes) a string in URL encoded format. Also referred to as 'URL decode'. - [codeblock] - print("https://example.org/?escaped=" + "Godot%20Engine%3A%27docs%27".http_unescape()) - [/codeblock] + Returns a copy of the string with special characters escaped using the JSON standard. </description> </method> - <method name="humanize_size"> - <return type="String"> - </return> - <argument index="0" name="size" type="int"> - </argument> + <method name="left" qualifiers="const"> + <return type="String" /> + <argument index="0" name="position" type="int" /> <description> - Converts [code]size[/code] represented as number of bytes to human-readable format using internationalized set of data size units, namely: B, KiB, MiB, GiB, TiB, PiB, EiB. Note that the next smallest unit is picked automatically to hold at most 1024 units. + Returns a number of characters from the left of the string. If negative [code]position[/code] is used, the characters are counted downwards from [String]'s length. + Examples: [codeblock] - var bytes = 133790307 - var size = String.humanize_size(bytes) - print(size) # prints "127.5 MiB" + print("sample text".left(3)) #prints "sam" + print("sample text".left(-3)) #prints "sample t" [/codeblock] </description> </method> - <method name="insert"> - <return type="String"> - </return> - <argument index="0" name="position" type="int"> - </argument> - <argument index="1" name="what" type="String"> - </argument> - <description> - Returns a copy of the string with the substring [code]what[/code] inserted at the 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, 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, returns [code]true[/code] if the path is relative. - </description> - </method> - <method name="is_subsequence_of"> - <return type="bool"> - </return> - <argument index="0" name="text" type="String"> - </argument> + <method name="length" qualifiers="const"> + <return type="int" /> <description> - Returns [code]true[/code] if this string is a subsequence of the given string. + Returns the string's amount of characters. </description> </method> - <method name="is_subsequence_ofi"> - <return type="bool"> - </return> - <argument index="0" name="text" type="String"> - </argument> + <method name="lpad" qualifiers="const"> + <return type="String" /> + <argument index="0" name="min_length" type="int" /> + <argument index="1" name="character" type="String" default="" "" /> <description> - Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. + Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the left of the string. </description> </method> - <method name="is_valid_filename"> - <return type="bool"> - </return> + <method name="lstrip" qualifiers="const"> + <return type="String" /> + <argument index="0" name="chars" type="String" /> <description> - Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being: - [code]: / \ ? * " | % < >[/code] + Returns a copy of the string with characters removed from the left. The [code]chars[/code] argument is a string specifying the set of characters to be removed. + [b]Note:[/b] The [code]chars[/code] is not a prefix. See [method trim_prefix] method that will remove a single prefix string rather than a set of characters. </description> </method> - <method name="is_valid_float"> - <return type="bool"> - </return> + <method name="match" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="expr" type="String" /> <description> - Returns [code]true[/code] if this string contains a valid float. + Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> - <method name="is_valid_hex_number"> - <return type="bool"> - </return> - <argument index="0" name="with_prefix" type="bool" default="false"> - </argument> + <method name="matchn" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="expr" type="String" /> <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]. + Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> - <method name="is_valid_html_color"> - <return type="bool"> - </return> + <method name="md5_buffer" qualifiers="const"> + <return type="PackedByteArray" /> <description> - Returns [code]true[/code] if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or [code]hsl()[/code] colors aren't considered valid by this method and will return [code]false[/code]. + Returns the MD5 hash of the string as an array of bytes. </description> </method> - <method name="is_valid_identifier"> - <return type="bool"> - </return> + <method name="md5_text" qualifiers="const"> + <return type="String" /> <description> - 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. + Returns the MD5 hash of the string as a string. </description> </method> - <method name="is_valid_integer"> - <return type="bool"> - </return> + <method name="naturalnocasecmp_to" qualifiers="const"> + <return type="int" /> + <argument index="0" name="to" type="String" /> <description> - Returns [code]true[/code] if this string contains a valid integer. + Performs a case-insensitive [i]natural order[/i] comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. + When used for sorting, natural order comparison will order suites of numbers as expected by most people. If you sort the numbers from 1 to 10 using natural order, you will get [code][1, 2, 3, ...][/code] instead of [code][1, 10, 2, 3, ...][/code]. + [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. + [b]Behavior with empty strings:[/b] Returns [code]-1[/code] if the "base" string is empty, [code]1[/code] if the [code]to[/code] string is empty or [code]0[/code] if both strings are empty. + To get a boolean result from a string comparison, use the [code]==[/code] operator instead. See also [method nocasecmp_to] and [method casecmp_to]. </description> </method> - <method name="is_valid_ip_address"> - <return type="bool"> - </return> + <method name="nocasecmp_to" qualifiers="const"> + <return type="int" /> + <argument index="0" name="to" type="String" /> <description> - Returns [code]true[/code] if this string contains a valid IP address. + 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. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/url] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. + [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. + [b]Behavior with empty strings:[/b] Returns [code]-1[/code] if the "base" string is empty, [code]1[/code] if the [code]to[/code] string is empty or [code]0[/code] if both strings are empty. + To get a boolean result from a string comparison, use the [code]==[/code] operator instead. See also [method casecmp_to] and [method naturalnocasecmp_to]. </description> </method> - <method name="join"> - <return type="String"> - </return> - <argument index="0" name="parts" type="PackedStringArray"> - </argument> + <method name="num" qualifiers="static"> + <return type="String" /> + <argument index="0" name="number" type="float" /> + <argument index="1" name="decimals" type="int" default="-1" /> <description> - Return a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method. - Example: + Converts a [float] to a string representation of a decimal number. + The number of decimal places can be specified with [code]decimals[/code]. If [code]decimals[/code] is [code]-1[/code] (default), decimal places will be automatically adjusted so that the string representation has 14 significant digits (counting both digits to the left and the right of the decimal point). + Trailing zeros are not included in the string. The last digit will be rounded and not truncated. + Some examples: [codeblock] - print(", ".join(["One", "Two", "Three", "Four"])) + String.num(3.141593) # "3.141593" + String.num(3.141593, 3) # "3.142" + String.num(3.14159300) # "3.141593", no trailing zeros. + # Last digit will be rounded up here, which reduces total digit count since + # trailing zeros are removed: + String.num(42.129999, 5) # "42.13" + # If `decimals` is not specified, the total amount of significant digits is 14: + String.num(-0.0000012345432123454321) # "-0.00000123454321" + String.num(-10000.0000012345432123454321) # "-10000.0000012345" [/codeblock] </description> </method> - <method name="json_escape"> - <return type="String"> - </return> + <method name="num_scientific" qualifiers="static"> + <return type="String" /> + <argument index="0" name="number" type="float" /> <description> - Returns a copy of the string with special characters escaped using the JSON standard. </description> </method> - <method name="left"> - <return type="String"> - </return> - <argument index="0" name="position" type="int"> - </argument> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Returns a number of characters from the left of the string. </description> </method> - <method name="length"> - <return type="int"> - </return> + <method name="operator !=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> <description> - Returns the string's amount of characters. </description> </method> - <method name="lstrip"> - <return type="String"> - </return> - <argument index="0" name="chars" type="String"> - </argument> + <method name="operator %" qualifiers="operator"> + <return type="String" /> + <argument index="0" name="right" type="Variant" /> <description> - Returns a copy of the string with characters removed from the left. </description> </method> - <method name="match"> - <return type="bool"> - </return> - <argument index="0" name="expr" type="String"> - </argument> + <method name="operator +" qualifiers="operator"> + <return type="String" /> + <argument index="0" name="right" type="String" /> <description> - Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> - <method name="matchn"> - <return type="bool"> - </return> - <argument index="0" name="expr" type="String"> - </argument> + <method name="operator <" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). </description> </method> - <method name="md5_buffer"> - <return type="PackedByteArray"> - </return> + <method name="operator <=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Returns the MD5 hash of the string as an array of bytes. </description> </method> - <method name="md5_text"> - <return type="String"> - </return> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Returns the MD5 hash of the string as a string. </description> </method> - <method name="nocasecmp_to"> - <return type="int"> - </return> - <argument index="0" name="to" type="String"> - </argument> + <method name="operator ==" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> <description> - 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"> - <return type="int"> - </return> - <argument index="0" name="at" type="int"> - </argument> + <method name="operator >" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Returns the character code at position [code]at[/code]. </description> </method> - <method name="pad_decimals"> - <return type="String"> - </return> - <argument index="0" name="digits" type="int"> - </argument> + <method name="operator >=" qualifiers="operator"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> <description> - Formats a number to have an exact number of [code]digits[/code] after the decimal point. </description> </method> - <method name="pad_zeros"> - <return type="String"> - </return> - <argument index="0" name="digits" type="int"> - </argument> + <method name="pad_decimals" qualifiers="const"> + <return type="String" /> + <argument index="0" name="digits" type="int" /> <description> - Formats a number to have an exact number of [code]digits[/code] before the decimal point. - </description> - </method> - <method name="percent_decode"> - <return type="String"> - </return> - <description> - Decode a percent-encoded string. See [method percent_encode]. + Formats a number to have an exact number of [code]digits[/code] after the decimal point. </description> </method> - <method name="percent_encode"> - <return type="String"> - </return> + <method name="pad_zeros" qualifiers="const"> + <return type="String" /> + <argument index="0" name="digits" type="int" /> <description> - Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). + Formats a number to have an exact number of [code]digits[/code] before the decimal point. </description> </method> - <method name="plus_file"> - <return type="String"> - </return> - <argument index="0" name="file" type="String"> - </argument> + <method name="plus_file" qualifiers="const"> + <return type="String" /> + <argument index="0" name="file" type="String" /> <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="repeat"> - <return type="String"> - </return> - <argument index="0" name="count" type="int"> - </argument> + <method name="repeat" qualifiers="const"> + <return type="String" /> + <argument index="0" name="count" type="int" /> <description> Returns original string repeated a number of times. The number of repetitions is given by the argument. </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> + <method name="replace" qualifiers="const"> + <return type="String" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="forwhat" type="String" /> <description> Replaces occurrences of a case-sensitive substring with the given one inside the string. </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> + <method name="replacen" qualifiers="const"> + <return type="String" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="forwhat" type="String" /> <description> Replaces occurrences of a case-insensitive substring with the given one inside the string. </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> + <method name="rfind" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="-1" /> <description> - Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning. + Returns the index of the [b]last[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. </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> + <method name="rfindn" qualifiers="const"> + <return type="int" /> + <argument index="0" name="what" type="String" /> + <argument index="1" name="from" type="int" default="-1" /> <description> - Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning. + Returns the index of the [b]last[/b] case-insensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the beginning of the string. </description> </method> - <method name="right"> - <return type="String"> - </return> - <argument index="0" name="position" type="int"> - </argument> + <method name="right" qualifiers="const"> + <return type="String" /> + <argument index="0" name="position" type="int" /> <description> - Returns the right side of the string from a given position. + Returns a number of characters from the right of the string. If negative [code]position[/code] is used, the characters are counted downwards from [String]'s length. + Examples: + [codeblock] + print("sample text".right(3)) #prints "ext" + print("sample text".right(-3)) #prints "ple text" + [/codeblock] </description> </method> - <method name="rsplit"> - <return type="PackedStringArray"> - </return> - <argument index="0" name="delimiter" type="String"> - </argument> - <argument index="1" name="allow_empty" type="bool" default="true"> - </argument> - <argument index="2" name="maxsplit" type="int" default="0"> - </argument> + <method name="rpad" qualifiers="const"> + <return type="String" /> + <argument index="0" name="min_length" type="int" /> + <argument index="1" name="character" type="String" default="" "" /> + <description> + Formats a string to be at least [code]min_length[/code] long by adding [code]character[/code]s to the right of the string. + </description> + </method> + <method name="rsplit" qualifiers="const"> + <return type="PackedStringArray" /> + <argument index="0" name="delimiter" type="String" /> + <argument index="1" name="allow_empty" type="bool" default="true" /> + <argument index="2" name="maxsplit" type="int" default="0" /> <description> Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right. The splits in the returned array are sorted in the same order as the original string, from left to right. If [code]maxsplit[/code] is specified, it defines the number of splits to do from the right up to [code]maxsplit[/code]. The default value of 0 means that all items are split, thus giving the same result as [method split]. Example: - [codeblock] + [codeblocks] + [gdscript] var some_string = "One,Two,Three,Four" var some_array = some_string.rsplit(",", true, 1) print(some_array.size()) # Prints 2 print(some_array[0]) # Prints "Four" print(some_array[1]) # Prints "Three,Two,One" - [/codeblock] + [/gdscript] + [csharp] + // There is no Rsplit. + [/csharp] + [/codeblocks] </description> </method> - <method name="rstrip"> - <return type="String"> - </return> - <argument index="0" name="chars" type="String"> - </argument> + <method name="rstrip" qualifiers="const"> + <return type="String" /> + <argument index="0" name="chars" type="String" /> <description> - Returns a copy of the string with characters removed from the right. + Returns a copy of the string with characters removed from the right. The [code]chars[/code] argument is a string specifying the set of characters to be removed. + [b]Note:[/b] The [code]chars[/code] is not a suffix. See [method trim_suffix] method that will remove a single suffix string rather than a set of characters. </description> </method> - <method name="sha1_buffer"> - <return type="PackedByteArray"> - </return> + <method name="sha1_buffer" qualifiers="const"> + <return type="PackedByteArray" /> <description> Returns the SHA-1 hash of the string as an array of bytes. </description> </method> - <method name="sha1_text"> - <return type="String"> - </return> + <method name="sha1_text" qualifiers="const"> + <return type="String" /> <description> Returns the SHA-1 hash of the string as a string. </description> </method> - <method name="sha256_buffer"> - <return type="PackedByteArray"> - </return> + <method name="sha256_buffer" qualifiers="const"> + <return type="PackedByteArray" /> <description> Returns the SHA-256 hash of the string as an array of bytes. </description> </method> - <method name="sha256_text"> - <return type="String"> - </return> + <method name="sha256_text" qualifiers="const"> + <return type="String" /> <description> Returns the SHA-256 hash of the string as a string. </description> </method> - <method name="similarity"> - <return type="float"> - </return> - <argument index="0" name="text" type="String"> - </argument> + <method name="similarity" qualifiers="const"> + <return type="float" /> + <argument index="0" name="text" type="String" /> <description> 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"> - <return type="PackedStringArray"> - </return> - <argument index="0" name="delimiter" type="String"> - </argument> - <argument index="1" name="allow_empty" type="bool" default="true"> - </argument> - <argument index="2" name="maxsplit" type="int" default="0"> - </argument> + <method name="split" qualifiers="const"> + <return type="PackedStringArray" /> + <argument index="0" name="delimiter" type="String" /> + <argument index="1" name="allow_empty" type="bool" default="true" /> + <argument index="2" name="maxsplit" type="int" default="0" /> <description> - Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. - If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of 0 means that all items are split. + Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. The [code]delimiter[/code] can be of any length. + If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of [code]0[/code] means that all items are split. Example: - [codeblock] + [codeblocks] + [gdscript] var some_string = "One,Two,Three,Four" var some_array = some_string.split(",", true, 1) print(some_array.size()) # Prints 2 - print(some_array[0]) # Prints "One" - print(some_array[1]) # Prints "Two,Three,Four" - [/codeblock] - </description> - </method> - <method name="split_floats"> - <return type="PackedFloat32Array"> - </return> - <argument index="0" name="delimiter" type="String"> - </argument> - <argument index="1" name="allow_empty" type="bool" default="true"> - </argument> + print(some_array[0]) # Prints "Four" + print(some_array[1]) # Prints "Three,Two,One" + [/gdscript] + [csharp] + var someString = "One,Two,Three,Four"; + var someArray = someString.Split(",", true); // This is as close as it gets to Godots API. + GD.Print(someArray[0]); // Prints "Four" + GD.Print(someArray[1]); // Prints "Three,Two,One" + [/csharp] + [/codeblocks] + If you need to split strings with more complex rules, use the [RegEx] class instead. + </description> + </method> + <method name="split_floats" qualifiers="const"> + <return type="PackedFloat32Array" /> + <argument index="0" name="delimiter" type="String" /> + <argument index="1" name="allow_empty" type="bool" default="true" /> <description> Splits the string in floats by using a delimiter string and returns an array of the substrings. For example, [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. </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> + <method name="strip_edges" qualifiers="const"> + <return type="String" /> + <argument index="0" name="left" type="bool" default="true" /> + <argument index="1" name="right" type="bool" default="true" /> <description> Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. </description> </method> - <method name="strip_escapes"> - <return type="String"> - </return> + <method name="strip_escapes" qualifiers="const"> + <return type="String" /> <description> Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation ([code]\t[/code] in C) and newline ([code]\n[/code] and [code]\r[/code]) characters, but not spaces. </description> </method> - <method name="substr"> - <return type="String"> - </return> - <argument index="0" name="from" type="int"> - </argument> - <argument index="1" name="len" type="int" default="-1"> - </argument> + <method name="substr" qualifiers="const"> + <return type="String" /> + <argument index="0" name="from" type="int" /> + <argument index="1" name="len" type="int" default="-1" /> <description> - Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using -1 will return remaining characters from given position. + Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position. </description> </method> - <method name="to_ascii"> - <return type="PackedByteArray"> - </return> + <method name="to_ascii_buffer" qualifiers="const"> + <return type="PackedByteArray" /> <description> - Converts the String (which is a character array) to [PackedByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII characters. + Converts the String (which is a character array) to ASCII/Latin-1 encoded [PackedByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8_buffer], as this method assumes that all the characters in the String are ASCII/Latin-1 characters, unsupported characters are replaced with spaces. </description> </method> - <method name="to_float"> - <return type="float"> - </return> + <method name="to_float" qualifiers="const"> + <return type="float" /> <description> Converts a string containing a decimal number into a [code]float[/code]. </description> </method> - <method name="to_int"> - <return type="int"> - </return> + <method name="to_int" qualifiers="const"> + <return type="int" /> <description> Converts a string containing an integer number into an [code]int[/code]. </description> </method> - <method name="to_lower"> - <return type="String"> - </return> + <method name="to_lower" qualifiers="const"> + <return type="String" /> <description> Returns the string converted to lowercase. </description> </method> - <method name="to_upper"> - <return type="String"> - </return> + <method name="to_upper" qualifiers="const"> + <return type="String" /> <description> Returns the string converted to uppercase. </description> </method> - <method name="to_utf8"> - <return type="PackedByteArray"> - </return> + <method name="to_utf16_buffer" qualifiers="const"> + <return type="PackedByteArray" /> + <description> + Converts the String (which is an array of characters) to UTF-16 encoded [PackedByteArray] (which is an array of bytes). + </description> + </method> + <method name="to_utf32_buffer" qualifiers="const"> + <return type="PackedByteArray" /> <description> - Converts the String (which is an array of characters) to [PackedByteArray] (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]. + Converts the String (which is an array of characters) to UTF-32 encoded [PackedByteArray] (which is an array of bytes). </description> </method> - <method name="trim_prefix"> - <return type="String"> - </return> - <argument index="0" name="prefix" type="String"> - </argument> + <method name="to_utf8_buffer" qualifiers="const"> + <return type="PackedByteArray" /> + <description> + Converts the String (which is an array of characters) to UTF-8 encode [PackedByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii_buffer], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii_buffer]. + </description> + </method> + <method name="trim_prefix" qualifiers="const"> + <return type="String" /> + <argument index="0" name="prefix" type="String" /> <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> + <method name="trim_suffix" qualifiers="const"> + <return type="String" /> + <argument index="0" name="suffix" type="String" /> <description> Removes a given string from the end if it ends with it or leaves the string unchanged. </description> </method> - <method name="xml_escape"> - <return type="String"> - </return> + <method name="unicode_at" qualifiers="const"> + <return type="int" /> + <argument index="0" name="at" type="int" /> + <description> + Returns the character code at position [code]at[/code]. + </description> + </method> + <method name="uri_decode" qualifiers="const"> + <return type="String" /> + <description> + Decodes a string in URL encoded format. This is meant to decode parameters in a URL when receiving an HTTP request. + [codeblocks] + [gdscript] + print("https://example.org/?escaped=" + "Godot%20Engine%3A%27docs%27".uri_decode()) + [/gdscript] + [csharp] + GD.Print("https://example.org/?escaped=" + "Godot%20Engine%3a%27Docs%27".URIDecode()); + [/csharp] + [/codeblocks] + </description> + </method> + <method name="uri_encode" qualifiers="const"> + <return type="String" /> + <description> + Encodes a string to URL friendly format. This is meant to encode parameters in a URL when sending an HTTP request. + [codeblocks] + [gdscript] + print("https://example.org/?escaped=" + "Godot Engine:'docs'".uri_encode()) + [/gdscript] + [csharp] + GD.Print("https://example.org/?escaped=" + "Godot Engine:'docs'".URIEncode()); + [/csharp] + [/codeblocks] + </description> + </method> + <method name="validate_node_name" qualifiers="const"> + <return type="String" /> + <description> + Removes any characters from the string that are prohibited in [Node] names ([code].[/code] [code]:[/code] [code]@[/code] [code]/[/code] [code]"[/code]). + </description> + </method> + <method name="xml_escape" qualifiers="const"> + <return type="String" /> + <argument index="0" name="escape_quotes" type="bool" default="false" /> <description> - Returns 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. If [code]escape_quotes[/code] is [code]true[/code], the single quote ([code]'[/code]) and double quote ([code]"[/code]) characters are also escaped. </description> </method> - <method name="xml_unescape"> - <return type="String"> - </return> + <method name="xml_unescape" qualifiers="const"> + <return type="String" /> <description> Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. </description> |