summaryrefslogtreecommitdiff
path: root/doc/classes/Thread.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-03-31 08:55:46 +0200
committerGitHub <noreply@github.com>2020-03-31 08:55:46 +0200
commitece425ace4f5d6a684d3f04bae65f3e179393d85 (patch)
tree76da358213a9181cf2173589bac3e457171355d1 /doc/classes/Thread.xml
parentdfed5efea3b5646cfca6662e52cf20c54558eb42 (diff)
parentd09644dff3ed3552f82e63d4a15f7f62442bf733 (diff)
Merge pull request #37452 from zak-grumbles/thread_start_docs_fix
Clarify docs for Thread.start() godotengine#36032
Diffstat (limited to 'doc/classes/Thread.xml')
-rw-r--r--doc/classes/Thread.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml
index 3bb5797df5..4d6e89fa6f 100644
--- a/doc/classes/Thread.xml
+++ b/doc/classes/Thread.xml
@@ -36,7 +36,7 @@
<argument index="3" name="priority" type="int" enum="Thread.Priority" default="1">
</argument>
<description>
- Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum.
+ Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum.
Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.
</description>
</method>