From 0608f2fca3f336b96fbecaa476001f1fd9a36ece Mon Sep 17 00:00:00 2001 From: mhilbrunner Date: Sun, 22 Oct 2017 22:55:21 +0200 Subject: [DOCS] String --- doc/classes/String.xml | 143 +++++++++++++++++++++++++++++-------------------- 1 file changed, 84 insertions(+), 59 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/String.xml b/doc/classes/String.xml index c7c19997b9..546712f223 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -17,6 +17,7 @@ + Constructs a new String from the given [bool]. @@ -25,6 +26,7 @@ + Constructs a new String from the given [int]. @@ -33,6 +35,7 @@ + Constructs a new String from the given [float]. @@ -41,6 +44,7 @@ + Constructs a new String from the given [Vector2]. @@ -49,6 +53,7 @@ + Constructs a new String from the given [Rect2]. @@ -57,6 +62,7 @@ + Constructs a new String from the given [Vector3]. @@ -65,6 +71,7 @@ + Constructs a new String from the given [Transform2D]. @@ -73,6 +80,7 @@ + Constructs a new String from the given [Plane]. @@ -81,6 +89,7 @@ + Constructs a new String from the given [Quat]. @@ -89,6 +98,7 @@ + Constructs a new String from the given [Rect3]. @@ -97,6 +107,7 @@ + Constructs a new String from the given [Basis]. @@ -105,6 +116,7 @@ + Constructs a new String from the given [Transform]. @@ -113,6 +125,7 @@ + Constructs a new String from the given [Color]. @@ -121,6 +134,7 @@ + Constructs a new String from the given [NodePath]. @@ -129,6 +143,7 @@ + Constructs a new String from the given [RID]. @@ -137,6 +152,7 @@ + Constructs a new String from the given [Dictionary]. @@ -145,6 +161,7 @@ + Constructs a new String from the given [Array]. @@ -153,6 +170,7 @@ + Constructs a new String from the given [PoolByteArray]. @@ -161,6 +179,7 @@ + Constructs a new String from the given [PoolIntArray]. @@ -169,6 +188,7 @@ + Constructs a new String from the given [PoolRealArray]. @@ -177,6 +197,7 @@ + Constructs a new String from the given [PoolStringArray]. @@ -185,6 +206,7 @@ + Constructs a new String from the given [PoolVector2Array]. @@ -193,6 +215,7 @@ + Constructs a new String from the given [PoolVector3Array]. @@ -201,6 +224,7 @@ + Constructs a new String from the given [PoolColorArray]. @@ -209,35 +233,35 @@ - Return true if the strings begins with the given string. + Returns [code]true[/code] if the string begins with the given string. - Return the bigrams (pairs of consecutive letters) of this string. + Returns the bigrams (pairs of consecutive letters) of this string. - Return a copy of the string with special characters escaped using the C language standard. + Returns a copy of the string with special characters escaped using the C language standard. - Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. + Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. - Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. + Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. @@ -246,14 +270,14 @@ - Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal. - Return true if the string is empty. + Returns [code]true[/code] if the string is empty. @@ -262,7 +286,7 @@ - Return true if the strings ends with the given string. + Returns [code]true[/code] if the string ends with the given string. @@ -271,7 +295,7 @@ - Erase [code]chars[/code] characters from the string starting from [code]position[/code]. + Erases [code]chars[/code] characters from the string starting from [code]position[/code]. @@ -282,7 +306,7 @@ - Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -291,7 +315,7 @@ - Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -302,7 +326,7 @@ - Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -313,48 +337,49 @@ + Formats the string by replacing all occurences of [code]placeholder[/code] with [code]values[/code]. - If the string is a path to a file, return the base directory. + If the string is a valid file path, returns the base directory name. - If the string is a path to a file, return the path to the file without the extension. + If the string is a valid file path, returns the full file path without the extension. - If the string is a path to a file, return the extension. + If the string is a valid file path, returns the extension. - If the string is a path to a file, return the file and ignore the base directory. + If the string is a valid file path, returns the filename. - Hash the string and return a 32 bits integer. + Hashes the string and returns a 32-bit integer. - Convert a string containing a hexadecimal number into an int. + Converts a string containing a hexadecimal number into an integer. @@ -365,21 +390,21 @@ - Insert a substring at a given position. + Inserts a substring at a given position. - If the string is a path to a file or directory, return true if the path is absolute. + If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute. - If the string is a path to a file or directory, return true if the path is relative. + If the string is a path to a file or directory, returns [code]true[/code] if the path is relative. @@ -388,7 +413,7 @@ - Check whether this string is a subsequence of the given string. + Returns [code]true[/code] if this string is a subsequence of the given string. @@ -397,49 +422,49 @@ - Check whether this string is a subsequence of the given string, without considering case. + Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. - Check whether the string contains a valid float. + Returns [code]true[/code] if this string contains a valid float. - Check whether the string contains a valid color in HTML notation. + Returns [code]true[/code] if this string contains a valid color in HTML notation. - Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. + Returns [code]true[/code] if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. - Check whether the string contains a valid integer. + Returns [code]true[/code] if this string contains a valid integer. - Check whether the string contains a valid IP address. + Returns [code]true[/code] if this string contains a valid IP address. - Return a copy of the string with special characters escaped using the JSON standard. + Returns a copy of the string with special characters escaped using the JSON standard. @@ -448,14 +473,14 @@ - Return an amount of characters from the left of the string. + Returns a number of characters from the left of the string. - Return the length of the string in characters. + Returns the string's amount of characters. @@ -464,7 +489,7 @@ - Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. + Does a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. @@ -473,21 +498,21 @@ - Do a simple case insensitive expression match, using ? and * wildcards (see [method match]). + Does a simple case insensitive expression match, using ? and * wildcards (see [method match]). - Return the MD5 hash of the string as an array of bytes. + Returns the MD5 hash of the string as an array of bytes. - Return the MD5 hash of the string as a string. + Returns the MD5 hash of the string as a string. @@ -496,7 +521,7 @@ - Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal. @@ -505,7 +530,7 @@ - Return the character code at position [code]at[/code]. + Returns the character code at position [code]at[/code]. @@ -514,7 +539,7 @@ - Format a number to have an exact number of [code]digits[/code] after the decimal point. + Formats a number to have an exact number of [code]digits[/code] after the decimal point. @@ -523,7 +548,7 @@ - Format a number to have an exact number of [code]digits[/code] before the decimal point. + Formats a number to have an exact number of [code]digits[/code] before the decimal point. @@ -537,7 +562,7 @@ - Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. + Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). @@ -557,7 +582,7 @@ - Replace occurrences of a substring for different ones inside the string. + Replaces occurrences of a substring with the given one inside the string. @@ -568,7 +593,7 @@ - Replace occurrences of a substring for different ones inside the string, but search case-insensitive. + Replaces occurrences of a substring with the given one inside the string. Ignores case. @@ -579,7 +604,7 @@ - Perform a search for a substring, but start from the end of the string instead of the beginning. + Performs a search for a substring, but starts from the end of the string instead of the beginning. @@ -590,7 +615,7 @@ - Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. + Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. @@ -599,7 +624,7 @@ - Return the right side of the string from a given position. + Returns the right side of the string from a given position. @@ -612,7 +637,7 @@ - Return the SHA-256 hash of the string as a string. + Returns the SHA-256 hash of the string as a string. @@ -621,7 +646,7 @@ - Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. + Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. @@ -632,7 +657,7 @@ - Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". @@ -643,7 +668,7 @@ - Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". @@ -654,7 +679,7 @@ - Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. @@ -665,63 +690,63 @@ - Return part of the string from the position [code]from[/code], with length [code]len[/code]. + Returns part of the string from the position [code]from[/code] with length [code]len[/code]. - Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. + Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is sped up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. - Convert a string, containing a decimal number, into a [code]float[/code]. + Converts a string containing a decimal number into a [code]float[/code]. - Convert a string, containing an integer number, into an [code]int[/code]. + Converts a string containing an integer number into an [code]int[/code]. - Return the string converted to lowercase. + Returns the string converted to lowercase. - Return the string converted to uppercase. + Returns the string converted to uppercase. - Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). + Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). - Return a copy of the string with special characters escaped using the XML standard. + Returns a copy of the string with special characters escaped using the XML standard. - Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. + Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. -- cgit v1.2.3