summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-07-08 08:11:44 +0200
committerGitHub <noreply@github.com>2019-07-08 08:11:44 +0200
commit5869f9c735610e2ca1f17dc8821fcb2e80e0ac78 (patch)
treecb950c8461990e314c27f5b1a1fcb534ea1b96d3 /doc/classes
parent06a42123779fd3c0f3118ddbd8ed393861f25ee3 (diff)
parentbb89cf6ab0fc61a4da6c317bae1a042a48c6373c (diff)
Merge pull request #30414 from Larpon/docs/string-http_escape-methods
Provide documentation for String http_escape() and http_unescape() methods
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/String.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index 1934c5af9a..15d796be54 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -392,12 +392,20 @@
<return type="String">
</return>
<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]
</description>
</method>
<method name="http_unescape">
<return type="String">
</return>
<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]
</description>
</method>
<method name="insert">