summaryrefslogtreecommitdiffstats
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authormdavisprog <mdavisprog@gmail.com>2021-08-12 20:36:23 -0700
committermdavisprog <mdavisprog@gmail.com>2022-05-03 17:27:17 -0700
commitf3c1232c5984a540c33841694469febbe951e7a8 (patch)
tree216cf28e0079c5e34abaac465424c7d373ffe8a5 /doc/classes/OS.xml
parent1b2992799b324479b3fba9e05ae6226a46cb4143 (diff)
downloadredot-engine-f3c1232c5984a540c33841694469febbe951e7a8.tar.gz
Add OS::is_process_running function.
Adds the is_process_running function to the native OS class and exposes it to script. This is implemented on Windows and Unix platforms. A stub is provided for other platforms that do not support this function. Documentation is updated to reflect new API function.
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index f45bee4db4..266a2573de 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -434,6 +434,15 @@
Returns [code]true[/code] if the input keycode corresponds to a Unicode character.
</description>
</method>
+ <method name="is_process_running" qualifiers="const">
+ <return type="bool" />
+ <argument index="0" name="pid" type="int" />
+ <description>
+ Returns [code]true[/code] if the child process ID ([code]pid[/code]) is still running or [code]false[/code] if it has terminated.
+ Must be a valid ID generated from [method create_process].
+ [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows.
+ </description>
+ </method>
<method name="is_stdout_verbose" qualifiers="const">
<return type="bool" />
<description>