godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

clarify OS.execute usage, add examples

This commit is contained in:
Todd Ross 2018-01-20 17:45:21 -06:00
parent 00387cbe1b
commit b57dcf446e
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/classes/OS.xml
View File

@ -87,7 +87,18 @@
<argument index="3" name="output" type="Array" default="[ ]"> <argument index="3" name="output" type="Array" default="[ ]">
</argument> </argument>
<description> <description>
Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. Execute the file at the given path, optionally blocking until it returns.
Platform path resolution will take place. The resolved file must exist and be executable.
Returns a process id.
For example:
[codeblock]
var output = []
var pid = OS.execute('ls', [], true, output)
[/codeblock]
If you wish to access a shell built-in or perform a composite command, a platform specific shell can be invoked. For example:
[codeblock]
var pid = OS.execute('CMD.exe', ['/C', 'cd %TEMP% &amp;&amp; dir'], true, output)
[/codeblock]
</description> </description>
</method> </method>
<method name="find_scancode_from_string" qualifiers="const"> <method name="find_scancode_from_string" qualifiers="const">