Browse Source

Merge pull request #60645 from timothyqiu/scene-tree-tween-finished

[3.x] Add missing description of finished signal of SceneTreeTween
Rémi Verschelde 3 years ago
parent
commit
0df87c33f5
1 changed files with 2 additions and 0 deletions
  1. 2 0
      doc/classes/SceneTreeTween.xml

+ 2 - 0
doc/classes/SceneTreeTween.xml

@@ -295,6 +295,8 @@
 	<signals>
 		<signal name="finished">
 			<description>
+				Emitted when the [SceneTreeTween] has finished all tweening. Never emitted when the [SceneTreeTween] is set to infinite looping (see [method set_loops]).
+				[b]Note:[/b] The [SceneTreeTween] is removed (invalidated) after this signal is emitted, but it doesn't happen immediately, but on the next processing frame. Calling [method stop] inside the signal callback will preserve the [SceneTreeTween].
 			</description>
 		</signal>
 		<signal name="loop_finished">