summaryrefslogtreecommitdiff
path: root/doc/classes/SceneTree.xml
diff options
context:
space:
mode:
authorChris Bradfield <cb@scribe.net>2019-02-23 18:56:10 -0800
committerChris Bradfield <cb@scribe.net>2019-02-24 20:30:26 -0800
commit08c3a2241d4b761db3a7e8262bec5ca91848ae8d (patch)
tree85f53fc14d0c0231a926142649db4b3924122e27 /doc/classes/SceneTree.xml
parentef61c14dda30a6923b587d516344bbdca6983660 (diff)
[DOCS] Minor classref updates.
Diffstat (limited to 'doc/classes/SceneTree.xml')
-rw-r--r--doc/classes/SceneTree.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index f39d221d89..7e696badb2 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -64,6 +64,13 @@
</argument>
<description>
Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If [code]pause_mode_process[/code] is set to false, pausing the SceneTree will also pause the timer.
+ Commonly used to create a one-shot delay timer as in the following example:
+ [codeblock]
+ func some_function():
+ print("start")
+ yield(get_tree().create_timer(1.0), "timeout")
+ print("end")
+ [/codeblock]
</description>
</method>
<method name="get_frame" qualifiers="const">