asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve the OS.shell_open() documentation

Browse source 
This adds a `mailto:` example to `OS.shell_open()`.
This commit is contained in:
Hugo Locurcio 2019-09-23 18:30:12 +02:00
parent a226d63f68
commit 5d676682b4
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/OS.xml
View file

@ -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">