summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Alexsander <michaelalexsander@protonmail.com>2023-05-07 23:28:56 -0300
committerRĂ©mi Verschelde <rverschelde@gmail.com>2023-05-12 12:11:23 +0200
commitb7206e25bf1c74f02f950d22fe5ca82429f9dab4 (patch)
tree56ff6c51287937e252cf9e6005aed457db2dd9b6 /doc
parent5d93de88a8be7e1a77975ae60d6cc2dfd7de64a0 (diff)
Improve some descriptions in the OS docs
(cherry picked from commit 6db12c5e50017940df7921e37c9a85eb376881ed)
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/OS.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 95646d6c15..ce4f1fbcd4 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -91,7 +91,7 @@
<param index="3" name="read_stderr" type="bool" default="false" />
<param index="4" name="open_console" type="bool" default="false" />
<description>
- Executes a command. The file specified in [param path] must exist and be executable. Platform path resolution will be used. The [param arguments] are used in the given order and separated by a space. If an [param output] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [param output]. If [param read_stderr] is [code]true[/code], the output to the standard error stream will be included too.
+ Executes a command. The file specified in [param path] must exist and be executable. Platform path resolution will be used. The [param arguments] are used in the given order, separated by spaces, and wrapped in quotes. If an [param output] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [param output]. If [param read_stderr] is [code]true[/code], the output to the standard error stream will be included too.
On Windows, if [param open_console] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms.
If the command is successfully executed, the method will return the exit code of the command, or [code]-1[/code] if it fails.
[b]Note:[/b] The Godot thread will pause its execution until the executed command terminates. Use [Thread] to create a separate thread that will not pause the Godot thread, or use [method create_process] to create a completely independent process.