diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2018-09-27 09:34:08 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2018-09-27 09:34:08 +0200 |
| commit | 9108b5fba5b325ba0dc4731d2623645c9a1d40a1 (patch) | |
| tree | 49e7130602ea88d0adc250bd0ba3ed8c49a45871 | |
| parent | 2e877031369c35c918c014a7ae3688b6f555e5bd (diff) | |
doc: Fix OS.execute example (cf. #22412)
| -rw-r--r-- | doc/classes/OS.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index c41084f853..dad4ce898d 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -101,7 +101,7 @@ </argument> <description> Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. - The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-c', '3', 'godotengine.org'])[/code] will resolve to [code]ping -c 3 godotengine.org[/code] in the system's shell. + The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-w', '3', 'godotengine.org'], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. This method has slightly different behaviour based on whether the [code]blocking[/code] mode is enabled. When [code]blocking[/code] is enabled, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the [code]output[/code] array as a single string. When the process terminates, the Godot thread will resume execution. When [code]blocking[/code] is disabled, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so [code]output[/code] will be empty. |