summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-12-27 16:49:46 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-12-27 16:54:18 +0100
commit35b046ddf7eab341256cced9d1c77e168c52e256 (patch)
tree801378798192580673fbd225f54c8ab6693b5545 /doc
parentd55e335026e4848d4d2ec21db8f334a9429c8cc8 (diff)
Add an `OS.get_thread_caller_id()` method
This can be used to print thread IDs in logs. This can make it easier to debug multi-threaded applications. Co-authored-by: Khaos <khaos@khaos-coders.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/OS.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 65a815a603..f72590f62f 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -127,6 +127,14 @@
Returns the keycode of the given string (e.g. "Escape").
</description>
</method>
+ <method name="get_thread_caller_id" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications.
+ [b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts.
+ </description>
+ </method>
<method name="get_cmdline_args">
<return type="PackedStringArray">
</return>