diff --git a/doc_classes/BTPauseAnimation.xml b/doc_classes/BTPauseAnimation.xml index 0fa31fc..0f9b767 100644 --- a/doc_classes/BTPauseAnimation.xml +++ b/doc_classes/BTPauseAnimation.xml @@ -1,17 +1,17 @@ - BT action that pauses playback of an animation on the specified AnimationPlayer node. + BT action that pauses playback of an animation on the specified [AnimationPlayer] node. - BTPauseAnimation action pauses playback of an animation on the specified [class AnimationPlayer] node and returns [code]SUCCESS[/code]. - Returns [code]FAILURE[/code] if the action fails to acquire AnimationPlayer node. + BTPauseAnimation action pauses playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code]. + Returns [code]FAILURE[/code] if the action fails to acquire [AnimationPlayer] node. - Parameter that specifies the AnimationPlayer node. + Parameter that specifies the [AnimationPlayer] node. diff --git a/doc_classes/BTPlayAnimation.xml b/doc_classes/BTPlayAnimation.xml index f4f20dd..97bd599 100644 --- a/doc_classes/BTPlayAnimation.xml +++ b/doc_classes/BTPlayAnimation.xml @@ -1,10 +1,10 @@ - BT action that plays an animation on the specified AnimationPlayer node. + 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 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. @@ -13,10 +13,10 @@ - Animation's key within the AnimationPlayer node. If empty, BTPlayAnimation will resume the last played animation if [class AnimationPlayer] was paused. + Animation's key within the [AnimationPlayer] node. If empty, BTPlayAnimation will resume the last played animation if [AnimationPlayer] was paused. - Parameter that specifies the AnimationPlayer node. + Parameter that specifies the [AnimationPlayer] node. Duration to wait for the animation to finish (in seconds). diff --git a/doc_classes/BTStopAnimation.xml b/doc_classes/BTStopAnimation.xml index f3abf17..c0962ff 100644 --- a/doc_classes/BTStopAnimation.xml +++ b/doc_classes/BTStopAnimation.xml @@ -1,20 +1,20 @@ - BT action that stops playback of an animation on the specified AnimationPlayer node. + BT action that stops 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 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. - 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 playback if the specified animation is currently playing. - Parameter that specifies the AnimationPlayer node. + Parameter that specifies the [AnimationPlayer] node. If [code]true[/code], the animation state is not updated visually.