Browse Source

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.
Hugo Locurcio 3 years ago
parent
commit
796ea60d11
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/SceneTreeTimer.xml

+ 2 - 1
doc/classes/SceneTreeTimer.xml

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