diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-09-23 18:30:12 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-09-23 18:37:47 +0200 |
| commit | 5d676682b405e9259b13ebba008978bbd383d206 (patch) | |
| tree | 48c45d43062fbcda2ff4b2d538acd2f37bbf55d7 /doc | |
| parent | a226d63f6815836284f947ccc56b688448381f84 (diff) | |
Improve the `OS.shell_open()` documentation
This adds a `mailto:` example to `OS.shell_open()`.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/OS.xml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 938777a36b..8fecb357f6 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -828,9 +828,10 @@ <argument index="0" name="uri" type="String"> </argument> <description> - Requests the OS to open a resource with the most appropriate program. For example. - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user. - [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website. + Requests the OS to open a resource with the most appropriate program. For example: + - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder. + - [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://blog.escapecreative.com/customizing-mailto-links/]Customizing [code]mailto:[/code] Links[/url] for a list of fields that can be added. </description> </method> <method name="show_virtual_keyboard"> |