Browse Source

Merge pull request #30414 from Larpon/docs/string-http_escape-methods

Provide documentation for String http_escape() and http_unescape() methods
Rémi Verschelde 6 years ago
parent
commit
5869f9c735
1 changed files with 8 additions and 0 deletions
  1. 8 0
      doc/classes/String.xml

+ 8 - 0
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">