:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BTPauseAnimation.xml.

.. _class_BTPauseAnimation:

BTPauseAnimation
================

**Inherits:** :ref:`BTAction<class_BTAction>` **<** :ref:`BTTask<class_BTTask>` **<** :ref:`BT<class_BT>`

BT action that pauses the playback of an animation on the specified ``AnimationPlayer`` node.

.. rst-class:: classref-introduction-group

Description
-----------

BTPauseAnimation action pauses the playback of an animation on the specified ``AnimationPlayer`` node and returns ``SUCCESS``.

Returns ``FAILURE`` if the action fails to get the ``AnimationPlayer`` node.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+---------------------------------------------------------------------------+
   | :ref:`BBNode<class_BBNode>` | :ref:`animation_player<class_BTPauseAnimation_property_animation_player>` |
   +-----------------------------+---------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_BTPauseAnimation_property_animation_player:

.. rst-class:: classref-property

:ref:`BBNode<class_BBNode>` **animation_player** :ref:`🔗<class_BTPauseAnimation_property_animation_player>`

.. rst-class:: classref-property-setget

- |void| **set_animation_player**\ (\ value\: :ref:`BBNode<class_BBNode>`\ )
- :ref:`BBNode<class_BBNode>` **get_animation_player**\ (\ )

Parameter that specifies the ``AnimationPlayer`` node.

.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`