From 9eb912816f0a94401b933197ee1c4ed9c4eedca8 Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Sun, 13 Aug 2023 19:38:14 +0200 Subject: [PATCH] Add BTPlayAnimation class doc --- doc_classes/BTPlayAnimation.xml | 34 +++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 doc_classes/BTPlayAnimation.xml diff --git a/doc_classes/BTPlayAnimation.xml b/doc_classes/BTPlayAnimation.xml new file mode 100644 index 0000000..c082822 --- /dev/null +++ b/doc_classes/BTPlayAnimation.xml @@ -0,0 +1,34 @@ + + + + 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]. + 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. + + + + + + Animation's key within the AnimationPlayer node. + + + Parameter that specifies the AnimationPlayer node. + + + Duration to wait for the animation to finish (in seconds). + + + Custom blend time (in seconds). + + + Play animation from the end. Used in combination with negative [member speed] to play animation in reverse. + + + Custom playback speed scaling ratio. + + +