:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.2/modules/limboai/doc_classes/BTPlayAnimation.xml. .. _class_BTPlayAnimation: BTPlayAnimation =============== **Inherits:** :ref:`BTAction` **<** :ref:`BTTask` **<** :ref:`BT` BT action that plays an animation on the specified ``AnimationPlayer`` node. .. rst-class:: classref-introduction-group Description ----------- BTPlayAnimation action plays an animation on the specified ``AnimationPlayer`` node. If the :ref:`await_completion` is greater than ``0``, the action will wait for the animation to complete, with the maximum waiting time equal to :ref:`await_completion`. Returns ``SUCCESS`` if the animation finishes playing or if the elapsed time exceeds :ref:`await_completion`. When :ref:`await_completion` is set to ``0``, BTPlayAnimation doesn't wait for the animation to finish and immediately returns ``SUCCESS``. Returns ``RUNNING`` if the animation is still playing and the elapsed time is less than :ref:`await_completion`. Returns ``FAILURE`` if the action fails to play the requested animation. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+--------------------------------------------------------------------------+-----------+ | StringName | :ref:`animation_name` | ``&""`` | +-----------------------------+--------------------------------------------------------------------------+-----------+ | :ref:`BBNode` | :ref:`animation_player` | | +-----------------------------+--------------------------------------------------------------------------+-----------+ | float | :ref:`await_completion` | ``0.0`` | +-----------------------------+--------------------------------------------------------------------------+-----------+ | float | :ref:`blend` | ``-1.0`` | +-----------------------------+--------------------------------------------------------------------------+-----------+ | bool | :ref:`from_end` | ``false`` | +-----------------------------+--------------------------------------------------------------------------+-----------+ | float | :ref:`speed` | ``1.0`` | +-----------------------------+--------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_BTPlayAnimation_property_animation_name: .. rst-class:: classref-property StringName **animation_name** = ``&""`` .. rst-class:: classref-property-setget - void **set_animation_name** **(** StringName value **)** - StringName **get_animation_name** **(** **)** Animation's key within the ``AnimationPlayer`` node. If empty, BTPlayAnimation will resume the last played animation if the ``AnimationPlayer`` was previously paused. .. rst-class:: classref-item-separator ---- .. _class_BTPlayAnimation_property_animation_player: .. rst-class:: classref-property :ref:`BBNode` **animation_player** .. rst-class:: classref-property-setget - void **set_animation_player** **(** :ref:`BBNode` value **)** - :ref:`BBNode` **get_animation_player** **(** **)** Parameter that specifies the ``AnimationPlayer`` node. .. rst-class:: classref-item-separator ---- .. _class_BTPlayAnimation_property_await_completion: .. rst-class:: classref-property float **await_completion** = ``0.0`` .. rst-class:: classref-property-setget - void **set_await_completion** **(** float value **)** - float **get_await_completion** **(** **)** The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will return ``FAILURE``. If set to ``0``, BTPlayAnimation doesn't wait for the animation to finish and immediately returns ``SUCCESS``. .. rst-class:: classref-item-separator ---- .. _class_BTPlayAnimation_property_blend: .. rst-class:: classref-property float **blend** = ``-1.0`` .. rst-class:: classref-property-setget - void **set_blend** **(** float value **)** - float **get_blend** **(** **)** Custom blend time (in seconds). See :ref:`AnimationPlayer.play`. .. rst-class:: classref-item-separator ---- .. _class_BTPlayAnimation_property_from_end: .. rst-class:: classref-property bool **from_end** = ``false`` .. rst-class:: classref-property-setget - void **set_from_end** **(** bool value **)** - bool **get_from_end** **(** **)** Play animation from the end. Used in combination with negative :ref:`speed` to play animation in reverse. See :ref:`AnimationPlayer.play`. .. rst-class:: classref-item-separator ---- .. _class_BTPlayAnimation_property_speed: .. rst-class:: classref-property float **speed** = ``1.0`` .. rst-class:: classref-property-setget - void **set_speed** **(** float value **)** - float **get_speed** **(** **)** Custom playback speed scaling ratio. See :ref:`AnimationPlayer.play`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`