diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-12 14:30:46 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-12 14:30:46 +0100 |
| commit | a8a9892ad664410502f56a564923fd7cc04474a6 (patch) | |
| tree | e1e17c43edbc49eb25c9a0cddfaff9088bb3982e /doc | |
| parent | 5b627dec72554523aed1476c98f5482e2a499690 (diff) | |
| parent | f64dd732b8ac249d052519940e46129960e0d771 (diff) | |
Merge pull request #71218 from KoBeWi/unlimited_bikeshedding_lets_go
Split pause() from AnimationPlayer's stop()
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 9efd3ac939..ca0cbf0ca1 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -137,6 +137,13 @@ Returns [code]true[/code] if playing an animation. </description> </method> + <method name="pause"> + <return type="void" /> + <description> + Pauses the currently playing animation. The [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. + See also [method stop]. + </description> + </method> <method name="play"> <return type="void" /> <param index="0" name="name" type="StringName" default="""" /> @@ -201,10 +208,9 @@ </method> <method name="stop"> <return type="void" /> - <param index="0" name="reset" type="bool" default="true" /> <description> - Stops or pauses the currently playing animation. If [param reset] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. - If [param reset] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. + 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]. </description> </method> </methods> |