diff options
author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-15 11:48:54 +0200 |
---|---|---|
committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-15 11:52:00 +0200 |
commit | 04b25108ac3c2d4ded4006a685c98b2028899123 (patch) | |
tree | 080432b8090f70d4a2769cfc5cdef9ca13b8df1d /doc | |
parent | dad21acebdfc9df195068c94ee40629d34365036 (diff) |
Document which escape sequences are supported by `String.c_unescape()`
See https://github.com/godotengine/godot/issues/38716.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/String.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 78168562f1..71db03e84f 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -325,7 +325,8 @@ <return type="String"> </return> <description> - Returns 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. 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="capitalize"> @@ -413,7 +414,6 @@ </argument> <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: [codeblock] # Will evaluate to `false`. |