diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-03-03 11:07:34 +0100 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-03-14 13:59:04 +0100 |
| commit | e79477a4b5521243421038bd8aa4d18a6bc5c2d3 (patch) | |
| tree | 59114281eb2e36d437597699ff7c004986761866 | |
| parent | 0c1abbd79efea87b358be8a00fa2d903ccae4a3b (diff) | |
Document using `String.uri_encode()` with `OS.shell_open()`
(cherry picked from commit 81ac3c3e7157a290c02548e7ad6adf50fd6e5118)
| -rw-r--r-- | doc/classes/OS.xml | 1 | ||||
| -rw-r--r-- | doc/classes/String.xml | 4 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index ca090d596e..92ee2fb40b 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -634,6 +634,7 @@ - [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website. - [code]OS.shell_open("mailto:example@example.com")[/code] opens the default email client with the "To" field set to [code]example@example.com[/code]. See [url=https://datatracker.ietf.org/doc/html/rfc2368]RFC 2368 - The [code]mailto[/code] URL scheme[/url] for a list of fields that can be added. Use [method ProjectSettings.globalize_path] to convert a [code]res://[/code] or [code]user://[/code] path into a system path for use with this method. + [b]Note:[/b] Use [method String.uri_encode] to encode characters within URLs in a URL-safe, portable way. This is especially required for line breaks. Otherwise, [method shell_open] may not work correctly in a project exported to the Web platform. [b]Note:[/b] This method is implemented on Android, iOS, Web, Linux, macOS and Windows. </description> </method> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 53b34332d7..5e443b018c 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -970,7 +970,7 @@ <method name="uri_decode" qualifiers="const"> <return type="String" /> <description> - Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. + Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. See also [method uri_encode]. [codeblocks] [gdscript] var url = "$DOCS_URL/?highlight=Godot%20Engine%3%docs" @@ -986,7 +986,7 @@ <method name="uri_encode" qualifiers="const"> <return type="String" /> <description> - Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. + Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. See also [method uri_decode]. [codeblocks] [gdscript] var prefix = "$DOCS_URL/?highlight=" |