diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-07-28 01:05:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-28 01:05:19 +0200 |
| commit | 1e4b38fc5d7ecf65330beb7eca6a1cfd63639302 (patch) | |
| tree | 56b0e79d6b1f13a4b7fbf97ea33184907091f07b /doc/classes | |
| parent | 2f828135f8513dbd4769e32beb52072d69c7cc7d (diff) | |
| parent | aaeb60eafc44cda6151a1c6f06ac709335f06f00 (diff) | |
Merge pull request #62414 from Calinou/movie-maker-add-quit-on-end
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 5 | ||||
| -rw-r--r-- | doc/classes/Engine.xml | 6 |
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 653607610d..b24c439432 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -220,6 +220,10 @@ <member name="method_call_mode" type="int" setter="set_method_call_mode" getter="get_method_call_mode" enum="AnimationPlayer.AnimationMethodCallMode" default="0"> The call mode to use for Call Method tracks. </member> + <member name="movie_quit_on_finish" type="bool" setter="set_movie_quit_on_finish_enabled" getter="is_movie_quit_on_finish_enabled" default="false"> + If [code]true[/code] and the engine is running in Movie Maker mode (see [MovieWriter]), exits the engine with [method SceneTree.quit] as soon as an animation is done playing in this [AnimationPlayer]. A message is printed when the engine quits for this reason. + [b]Note:[/b] This obeys the same logic as the [signal animation_finished] signal, so it will not quit the engine if the animation is set to be looping. + </member> <member name="playback_active" type="bool" setter="set_active" getter="is_active"> If [code]true[/code], updates animations in response to process-related notifications. </member> @@ -253,6 +257,7 @@ <argument index="0" name="anim_name" type="StringName" /> <description> Notifies when an animation finished playing. + [b]Note:[/b] This signal is not emitted if an animation is looping. </description> </signal> <signal name="animation_started"> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 506992e3af..36dfee833b 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -151,6 +151,12 @@ [/codeblocks] </description> </method> + <method name="get_write_movie_path" qualifiers="const"> + <return type="String" /> + <description> + Returns the path to the [MovieWriter]'s output file, or an empty string if the engine wasn't started in Movie Maker mode. This path can be absolute or relative depending on how the user specified it. + </description> + </method> <method name="has_singleton" qualifiers="const"> <return type="bool" /> <argument index="0" name="name" type="StringName" /> |