diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-18 22:41:43 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-18 22:41:43 +0100 |
| commit | acd62443b665f57560db64912f833286eafa4971 (patch) | |
| tree | 3b4372b0c19a4af41b7edab09544054b9c74bfc8 /doc/classes | |
| parent | 5dd3a6dbe2a05ab72f8c5496561b02fdad4f7560 (diff) | |
| parent | d16004f2970797d4c6814707401b5494d23f5357 (diff) | |
Merge pull request #71619 from TokageItLab/add-keep-state-to-anim-stop
Add `p_keep_state` to `AnimationPlayer::stop()`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index ca0cbf0ca1..304caeef43 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -208,9 +208,11 @@ </method> <method name="stop"> <return type="void" /> + <param index="0" name="keep_state" type="bool" default="false" /> <description> - Stops the currently playing animation. The animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. - See also [method pause]. + Stops the currently playing animation. The animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. See also [method pause]. + If [param keep_state] is [code]true[/code], the animation state is not updated visually. + [b]Note:[/b] The method / audio / animation playback tracks will not be processed by this method. </description> </method> </methods> |