botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add BTPlayAnimation class doc

This commit is contained in:
Serhii Snitsaruk 2023-08-13 19:38:14 +02:00
parent 45cf74dca9
commit 9eb912816f
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc_classes/BTPlayAnimation.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTPlayAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that plays an animation on the specified AnimationPlayer node.
</brief_description>
<description>
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.
</description>
<tutorials>
</tutorials>
<members>
<member name="animation_name" type="StringName" setter="set_animation_name" getter="get_animation_name" default="&amp;&quot;&quot;">
Animation's key within the AnimationPlayer node.
</member>
<member name="animation_player" type="BBNode" setter="set_animation_player" getter="get_animation_player">
Parameter that specifies the AnimationPlayer node.
</member>
<member name="await_completion" type="float" setter="set_await_completion" getter="get_await_completion" default="0.0">
Duration to wait for the animation to finish (in seconds).
</member>
<member name="blend" type="float" setter="set_blend" getter="get_blend" default="-1.0">
Custom blend time (in seconds).
</member>
<member name="from_end" type="bool" setter="set_from_end" getter="get_from_end" default="false">
Play animation from the end. Used in combination with negative [member speed] to play animation in reverse.
</member>
<member name="speed" type="float" setter="set_speed" getter="get_speed" default="1.0">
Custom playback speed scaling ratio.
</member>
</members>
</class>