Rename the argument tag to param in XML documentation
This commit is contained in:
Yuri Sizov
@@ -18,21 +18,21 @@
|
||||
</constructor>
|
||||
<constructor name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<param index="0" name="from" type="String" />
|
||||
<description>
|
||||
Constructs a [String] as a copy of the given [String].
|
||||
</description>
|
||||
</constructor>
|
||||
<constructor name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="NodePath" />
|
||||
<param index="0" name="from" type="NodePath" />
|
||||
<description>
|
||||
Constructs a new String from the given [NodePath].
|
||||
</description>
|
||||
</constructor>
|
||||
<constructor name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<param index="0" name="from" type="StringName" />
|
||||
<description>
|
||||
Constructs a new String from the given [StringName].
|
||||
</description>
|
||||
@@ -41,7 +41,7 @@
|
||||
<methods>
|
||||
<method name="begins_with" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="text" type="String" />
|
||||
<param index="0" name="text" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the string begins with the given string.
|
||||
</description>
|
||||
@@ -92,7 +92,7 @@
|
||||
</method>
|
||||
<method name="casecmp_to" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="to" type="String" />
|
||||
<param index="0" name="to" 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. "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.
|
||||
@@ -102,7 +102,7 @@
|
||||
</method>
|
||||
<method name="chr" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="char" type="int" />
|
||||
<param index="0" name="char" type="int" />
|
||||
<description>
|
||||
Directly converts an decimal integer to a unicode character. Tables of these characters can be found in various locations, for example [url=https://unicodelookup.com/]here.[/url]
|
||||
[codeblock]
|
||||
@@ -113,25 +113,25 @@
|
||||
</method>
|
||||
<method name="contains" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the string contains the given string.
|
||||
</description>
|
||||
</method>
|
||||
<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" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="0" />
|
||||
<param index="2" name="to" type="int" default="0" />
|
||||
<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.
|
||||
</description>
|
||||
</method>
|
||||
<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" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="0" />
|
||||
<param index="2" name="to" type="int" default="0" />
|
||||
<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.
|
||||
</description>
|
||||
@@ -144,15 +144,15 @@
|
||||
</method>
|
||||
<method name="ends_with" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="text" type="String" />
|
||||
<param index="0" name="text" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the string ends with the given string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="find" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="from" type="int" default="0" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="0" />
|
||||
<description>
|
||||
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:
|
||||
@@ -169,16 +169,16 @@
|
||||
</method>
|
||||
<method name="findn" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="from" type="int" default="0" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="0" />
|
||||
<description>
|
||||
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="format" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="values" type="Variant" />
|
||||
<argument index="1" name="placeholder" type="String" default=""{_}"" />
|
||||
<param index="0" name="values" type="Variant" />
|
||||
<param index="1" name="placeholder" type="String" default=""{_}"" />
|
||||
<description>
|
||||
Formats the string by replacing all occurrences of [code]placeholder[/code] with the elements of [code]values[/code].
|
||||
[code]values[/code] can be a [Dictionary] or an [Array]. Any underscores in [code]placeholder[/code] will be replaced with the corresponding keys in advance. Array elements use their index as keys.
|
||||
@@ -234,8 +234,8 @@
|
||||
</method>
|
||||
<method name="get_slice" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="delimiter" type="String" />
|
||||
<argument index="1" name="slice" type="int" />
|
||||
<param index="0" name="delimiter" type="String" />
|
||||
<param index="1" name="slice" type="int" />
|
||||
<description>
|
||||
Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist.
|
||||
This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index.
|
||||
@@ -247,15 +247,15 @@
|
||||
</method>
|
||||
<method name="get_slice_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="delimiter" type="String" />
|
||||
<param index="0" name="delimiter" type="String" />
|
||||
<description>
|
||||
Splits a string using a [code]delimiter[/code] and returns a number of slices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_slicec" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="delimiter" type="int" />
|
||||
<argument index="1" name="slice" type="int" />
|
||||
<param index="0" name="delimiter" type="int" />
|
||||
<param index="1" name="slice" type="int" />
|
||||
<description>
|
||||
Splits a string using a Unicode character with code [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist.
|
||||
This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index.
|
||||
@@ -286,7 +286,7 @@
|
||||
</method>
|
||||
<method name="humanize_size" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="size" type="int" />
|
||||
<param index="0" name="size" type="int" />
|
||||
<description>
|
||||
Converts an integer representing a number of bytes into a human-readable form.
|
||||
Note that this output is in [url=https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes]IEC prefix format[/url], and includes [code]B[/code], [code]KiB[/code], [code]MiB[/code], [code]GiB[/code], [code]TiB[/code], [code]PiB[/code], and [code]EiB[/code].
|
||||
@@ -294,7 +294,7 @@
|
||||
</method>
|
||||
<method name="indent" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="prefix" type="String" />
|
||||
<param index="0" name="prefix" type="String" />
|
||||
<description>
|
||||
Returns a copy of the string with lines indented with [code]prefix[/code].
|
||||
For example, the string can be indented with two tabs using [code]"\t\t"[/code], or four spaces using [code]" "[/code]. The prefix can be any string so it can also be used to comment out strings with e.g. [code]"# "[/code]. See also [method dedent] to remove indentation.
|
||||
@@ -303,8 +303,8 @@
|
||||
</method>
|
||||
<method name="insert" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="position" type="int" />
|
||||
<argument index="1" name="what" type="String" />
|
||||
<param index="0" name="position" type="int" />
|
||||
<param index="1" name="what" type="String" />
|
||||
<description>
|
||||
Returns a copy of the string with the substring [code]what[/code] inserted at the given position.
|
||||
</description>
|
||||
@@ -329,14 +329,14 @@
|
||||
</method>
|
||||
<method name="is_subsequence_of" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="text" type="String" />
|
||||
<param index="0" name="text" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this string is a subsequence of the given string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_subsequence_ofn" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="text" type="String" />
|
||||
<param index="0" name="text" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this string is a subsequence of the given string, without considering case.
|
||||
</description>
|
||||
@@ -362,7 +362,7 @@
|
||||
</method>
|
||||
<method name="is_valid_hex_number" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="with_prefix" type="bool" default="false" />
|
||||
<param index="0" name="with_prefix" type="bool" default="false" />
|
||||
<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>
|
||||
@@ -405,7 +405,7 @@
|
||||
</method>
|
||||
<method name="join" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="parts" type="PackedStringArray" />
|
||||
<param index="0" name="parts" type="PackedStringArray" />
|
||||
<description>
|
||||
Returns a [String] which is the concatenation of the [code]parts[/code]. The separator between elements is the string providing this method.
|
||||
Example:
|
||||
@@ -427,7 +427,7 @@
|
||||
</method>
|
||||
<method name="left" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="length" type="int" />
|
||||
<param index="0" name="length" type="int" />
|
||||
<description>
|
||||
Returns a number of characters from the left of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length.
|
||||
Examples:
|
||||
@@ -445,15 +445,15 @@
|
||||
</method>
|
||||
<method name="lpad" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="min_length" type="int" />
|
||||
<argument index="1" name="character" type="String" default="" "" />
|
||||
<param index="0" name="min_length" type="int" />
|
||||
<param 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 left of the string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="lstrip" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="chars" type="String" />
|
||||
<param index="0" name="chars" type="String" />
|
||||
<description>
|
||||
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.
|
||||
@@ -461,14 +461,14 @@
|
||||
</method>
|
||||
<method name="match" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="expr" type="String" />
|
||||
<param index="0" name="expr" 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]). An empty string or empty expression always evaluates to [code]false[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="matchn" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="expr" type="String" />
|
||||
<param index="0" name="expr" 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]). An empty string or empty expression always evaluates to [code]false[/code].
|
||||
</description>
|
||||
@@ -487,7 +487,7 @@
|
||||
</method>
|
||||
<method name="naturalnocasecmp_to" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="to" type="String" />
|
||||
<param index="0" name="to" type="String" />
|
||||
<description>
|
||||
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].
|
||||
@@ -498,7 +498,7 @@
|
||||
</method>
|
||||
<method name="nocasecmp_to" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="to" type="String" />
|
||||
<param index="0" name="to" type="String" />
|
||||
<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. "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.
|
||||
@@ -508,8 +508,8 @@
|
||||
</method>
|
||||
<method name="num" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="number" type="float" />
|
||||
<argument index="1" name="decimals" type="int" default="-1" />
|
||||
<param index="0" name="number" type="float" />
|
||||
<param index="1" name="decimals" type="int" default="-1" />
|
||||
<description>
|
||||
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).
|
||||
@@ -530,91 +530,91 @@
|
||||
</method>
|
||||
<method name="num_int64" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="number" type="int" />
|
||||
<argument index="1" name="base" type="int" default="10" />
|
||||
<argument index="2" name="capitalize_hex" type="bool" default="false" />
|
||||
<param index="0" name="number" type="int" />
|
||||
<param index="1" name="base" type="int" default="10" />
|
||||
<param index="2" name="capitalize_hex" type="bool" default="false" />
|
||||
<description>
|
||||
Converts a signed [int] to a string representation of a number.
|
||||
</description>
|
||||
</method>
|
||||
<method name="num_scientific" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="number" type="float" />
|
||||
<param index="0" name="number" type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="num_uint64" qualifiers="static">
|
||||
<return type="String" />
|
||||
<argument index="0" name="number" type="int" />
|
||||
<argument index="1" name="base" type="int" default="10" />
|
||||
<argument index="2" name="capitalize_hex" type="bool" default="false" />
|
||||
<param index="0" name="number" type="int" />
|
||||
<param index="1" name="base" type="int" default="10" />
|
||||
<param index="2" name="capitalize_hex" type="bool" default="false" />
|
||||
<description>
|
||||
Converts a unsigned [int] to a string representation of a number.
|
||||
</description>
|
||||
</method>
|
||||
<method name="pad_decimals" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="digits" type="int" />
|
||||
<param index="0" name="digits" type="int" />
|
||||
<description>
|
||||
Formats a number to have an exact number of [code]digits[/code] after the decimal point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="pad_zeros" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="digits" type="int" />
|
||||
<param 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="plus_file" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="file" type="String" />
|
||||
<param 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" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="count" type="int" />
|
||||
<param 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" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="forwhat" type="String" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param 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" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="forwhat" type="String" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param 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" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="from" type="int" default="-1" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="-1" />
|
||||
<description>
|
||||
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" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="what" type="String" />
|
||||
<argument index="1" name="from" type="int" default="-1" />
|
||||
<param index="0" name="what" type="String" />
|
||||
<param index="1" name="from" type="int" default="-1" />
|
||||
<description>
|
||||
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" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="length" type="int" />
|
||||
<param index="0" name="length" type="int" />
|
||||
<description>
|
||||
Returns a number of characters from the right of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length.
|
||||
Examples:
|
||||
@@ -626,17 +626,17 @@
|
||||
</method>
|
||||
<method name="rpad" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="min_length" type="int" />
|
||||
<argument index="1" name="character" type="String" default="" "" />
|
||||
<param index="0" name="min_length" type="int" />
|
||||
<param 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" />
|
||||
<param index="0" name="delimiter" type="String" />
|
||||
<param index="1" name="allow_empty" type="bool" default="true" />
|
||||
<param 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.
|
||||
@@ -659,7 +659,7 @@
|
||||
</method>
|
||||
<method name="rstrip" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="chars" type="String" />
|
||||
<param index="0" name="chars" type="String" />
|
||||
<description>
|
||||
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.
|
||||
@@ -691,7 +691,7 @@
|
||||
</method>
|
||||
<method name="similarity" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="text" type="String" />
|
||||
<param index="0" name="text" type="String" />
|
||||
<description>
|
||||
Returns the similarity index ([url=https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient]Sorensen-Dice coefficient[/url]) of this string compared to another. A result of 1.0 means totally similar, while 0.0 means totally dissimilar.
|
||||
[codeblock]
|
||||
@@ -710,9 +710,9 @@
|
||||
</method>
|
||||
<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" />
|
||||
<param index="0" name="delimiter" type="String" />
|
||||
<param index="1" name="allow_empty" type="bool" default="true" />
|
||||
<param 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. The [code]delimiter[/code] can be of any length.
|
||||
If [code]allow_empty[/code] is [code]true[/code], and there are two adjacent delimiters in the string, it will add an empty string to the array of substrings at this position.
|
||||
@@ -739,8 +739,8 @@
|
||||
</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" />
|
||||
<param index="0" name="delimiter" type="String" />
|
||||
<param 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].
|
||||
@@ -749,8 +749,8 @@
|
||||
</method>
|
||||
<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" />
|
||||
<param index="0" name="left" type="bool" default="true" />
|
||||
<param 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>
|
||||
@@ -763,8 +763,8 @@
|
||||
</method>
|
||||
<method name="substr" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="int" />
|
||||
<argument index="1" name="len" type="int" default="-1" />
|
||||
<param index="0" name="from" type="int" />
|
||||
<param 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 [code]-1[/code] will return remaining characters from given position.
|
||||
</description>
|
||||
@@ -830,21 +830,21 @@
|
||||
</method>
|
||||
<method name="trim_prefix" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="prefix" type="String" />
|
||||
<param 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" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="suffix" type="String" />
|
||||
<param 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="unicode_at" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="at" type="int" />
|
||||
<param index="0" name="at" type="int" />
|
||||
<description>
|
||||
Returns the character code at position [code]at[/code].
|
||||
</description>
|
||||
@@ -885,7 +885,7 @@
|
||||
</method>
|
||||
<method name="xml_escape" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="escape_quotes" type="bool" default="false" />
|
||||
<param index="0" name="escape_quotes" type="bool" default="false" />
|
||||
<description>
|
||||
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>
|
||||
@@ -900,73 +900,73 @@
|
||||
<operators>
|
||||
<operator name="operator !=">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator !=">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="StringName" />
|
||||
<param index="0" name="right" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator %">
|
||||
<return type="String" />
|
||||
<argument index="0" name="right" type="Variant" />
|
||||
<param index="0" name="right" type="Variant" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator +">
|
||||
<return type="String" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator +">
|
||||
<return type="String" />
|
||||
<argument index="0" name="right" type="int" />
|
||||
<param index="0" name="right" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator <">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator <=">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator ==">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator ==">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="StringName" />
|
||||
<param index="0" name="right" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator >">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator >=">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="right" type="String" />
|
||||
<param index="0" name="right" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
<operator name="operator []">
|
||||
<return type="String" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<param index="0" name="index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</operator>
|
||||
|
||||
Reference in New Issue
Block a user