From 3d5cbbf50f491accb85a4b1cb8b0bdd836577e43 Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Wed, 18 Oct 2023 19:05:33 +0200 Subject: [PATCH] Improve docs for PlayAnimation & StopAnimation --- doc_classes/BTAwaitAnimation.xml | 4 ++-- doc_classes/BTPauseAnimation.xml | 2 +- doc_classes/BTPlayAnimation.xml | 12 ++++++------ doc_classes/BTStopAnimation.xml | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc_classes/BTAwaitAnimation.xml b/doc_classes/BTAwaitAnimation.xml index 5a345bf..628240d 100644 --- a/doc_classes/BTAwaitAnimation.xml +++ b/doc_classes/BTAwaitAnimation.xml @@ -4,9 +4,9 @@ BT action that waits for an animation to finish playing. - BTAwaitAnimation waits for an animation on the specified [AnimationPlayer] node to finish playing and returns [code]SUCCESS[/code]. + BTAwaitAnimation action waits for an animation on the specified [AnimationPlayer] node to finish playing and returns [code]SUCCESS[/code]. Returns [code]SUCCESS[/code] if the specified animation has finished playing or if the specified animation is not currently playing. - Returns [code]FAILURE[/code] if the specified animation doesn't exist or if the action fails to get [AnimationPlayer] instance. + Returns [code]FAILURE[/code] if the specified animation doesn't exist or if the action fails to get the [AnimationPlayer] node. diff --git a/doc_classes/BTPauseAnimation.xml b/doc_classes/BTPauseAnimation.xml index 0afc2e4..4eeaeb0 100644 --- a/doc_classes/BTPauseAnimation.xml +++ b/doc_classes/BTPauseAnimation.xml @@ -5,7 +5,7 @@ BTPauseAnimation action pauses the playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code]. - Returns [code]FAILURE[/code] if the action fails to acquire the [AnimationPlayer] node. + Returns [code]FAILURE[/code] if the action fails to get the [AnimationPlayer] node. diff --git a/doc_classes/BTPlayAnimation.xml b/doc_classes/BTPlayAnimation.xml index 97bd599..fc6c1e9 100644 --- a/doc_classes/BTPlayAnimation.xml +++ b/doc_classes/BTPlayAnimation.xml @@ -4,7 +4,7 @@ BT action that plays an animation on the specified [AnimationPlayer] node. - BTPlayAnimation action plays an animation on the specified [AnimationPlayer] node. If the [member await_completion] is greater than [code]0[/code], the action will wait for the animation to complete, with a maximum waiting time equal to [member await_completion]. + BTPlayAnimation action plays an animation on the specified [AnimationPlayer] node. If the [member await_completion] is greater than [code]0[/code], the action will wait for the animation to complete, with the maximum waiting time equal to [member await_completion]. Returns [code]SUCCESS[/code] if the animation finishes playing or if the elapsed time exceeds [member await_completion]. When [member await_completion] is set to [code]0[/code], BTPlayAnimation doesn't wait for the animation to finish and immediately returns [code]SUCCESS[/code]. Returns [code]RUNNING[/code] if the animation is still playing and the elapsed time is less than [member await_completion]. Returns [code]FAILURE[/code] if the action fails to play the requested animation. @@ -13,22 +13,22 @@ - Animation's key within the [AnimationPlayer] node. If empty, BTPlayAnimation will resume the last played animation if [AnimationPlayer] was paused. + Animation's key within the [AnimationPlayer] node. If empty, BTPlayAnimation will resume the last played animation if the [AnimationPlayer] was previously paused. Parameter that specifies the [AnimationPlayer] node. - Duration to wait for the animation to finish (in seconds). + The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will return [code]FAILURE[/code]. If set to [code]0[/code], BTPlayAnimation doesn't wait for the animation to finish and immediately returns [code]SUCCESS[/code]. - Custom blend time (in seconds). + Custom blend time (in seconds). See [method AnimationPlayer.play]. - Play animation from the end. Used in combination with negative [member speed] to play animation in reverse. + Play animation from the end. Used in combination with negative [member speed] to play animation in reverse. See [method AnimationPlayer.play]. - Custom playback speed scaling ratio. + Custom playback speed scaling ratio. See [method AnimationPlayer.play]. diff --git a/doc_classes/BTStopAnimation.xml b/doc_classes/BTStopAnimation.xml index c0962ff..9d0a769 100644 --- a/doc_classes/BTStopAnimation.xml +++ b/doc_classes/BTStopAnimation.xml @@ -1,17 +1,17 @@ - BT action that stops playback of an animation on the specified [AnimationPlayer] node. + BT action that stops the playback of an animation on the specified [AnimationPlayer] node. - BTStopAnimation action stops playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code]. If [member animation_name] is set, it will only stop playback if the specified animation is currently playing. - Returns [code]FAILURE[/code] if the action fails to acquire [AnimationPlayer] node. + BTStopAnimation action stops the playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code]. If [member animation_name] is set, it will only stop the playback if the specified animation is currently playing. + Returns [code]FAILURE[/code] if the action fails to get the [AnimationPlayer] node. - Animation's key within the [AnimationPlayer] node. If not empty, BTStopAnimation will only stop playback if the specified animation is currently playing. + Animation's key within the [AnimationPlayer] node. If not empty, BTStopAnimation will only stop the playback if the specified animation is currently playing. Parameter that specifies the [AnimationPlayer] node.