Document SceneTreeTimer being freed automatically when elapsed

The note was present in the SceneTree `create_timer()` class
documentation, but not in the SceneTreeTimer class documentation.
This commit is contained in:
Hugo Locurcio 2021-12-05 18:39:10 +01:00
parent c42e9bd589
commit 796ea60d11
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C

View file

@ -12,6 +12,7 @@
yield(get_tree().create_timer(1.0), "timeout") yield(get_tree().create_timer(1.0), "timeout")
print("Timer ended.") print("Timer ended.")
[/codeblock] [/codeblock]
The timer will be automatically freed after its time elapses.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -19,7 +20,7 @@
</methods> </methods>
<members> <members>
<member name="time_left" type="float" setter="set_time_left" getter="get_time_left"> <member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
The time remaining. The time remaining (in seconds).
</member> </member>
</members> </members>
<signals> <signals>