summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2021-01-23 12:53:22 -0500
committerRyan Roden-Corrent <ryan@rcorre.net>2021-01-25 08:05:09 -0500
commit6e7e4f82ecd142f280ae344c769978d3e92cca54 (patch)
tree662e46d5ab6e0871f58cb4c6bc9a88f09e4b9ecd
parentd39f6386ce3a7916dbb94fef5ff65e7599e060f0 (diff)
Clarify that create_timer does not require cleanup.
This is how I would expect it to work, but the docs didn't clarify, so I had to check the source just to make sure I wasn't responsible for freeing the timer: https://github.com/godotengine/godot/blob/d39f6386ce3a7916dbb94fef5ff65e7599e060f0/scene/main/scene_tree.cpp#L473
-rw-r--r--doc/classes/SceneTree.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index 2c99815abf..cfe6e4f738 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -75,6 +75,7 @@
yield(get_tree().create_timer(1.0), "timeout")
print("end")
[/codeblock]
+ The timer will be automatically freed after its time elapses.
</description>
</method>
<method name="get_frame" qualifiers="const">