:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeOneShot.xml. .. _class_AnimationNodeOneShot: AnimationNodeOneShot ==================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Plays an animation once in :ref:`AnimationNodeBlendTree`. .. rst-class:: classref-introduction-group Description ----------- A resource to add to an :ref:`AnimationNodeBlendTree`. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`AnimationTree <../tutorials/animation/animation_tree>` - `Third Person Shooter Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`autorestart` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`autorestart_delay` | ``1.0`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`autorestart_random_delay` | ``0.0`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`fadein_time` | ``0.1`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`fadeout_time` | ``0.1`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`MixMode` | :ref:`mix_mode` | ``0`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`sync` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AnimationNodeOneShot_MixMode: .. rst-class:: classref-enumeration enum **MixMode**: .. _class_AnimationNodeOneShot_constant_MIX_MODE_BLEND: .. rst-class:: classref-enumeration-constant :ref:`MixMode` **MIX_MODE_BLEND** = ``0`` .. _class_AnimationNodeOneShot_constant_MIX_MODE_ADD: .. rst-class:: classref-enumeration-constant :ref:`MixMode` **MIX_MODE_ADD** = ``1`` .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimationNodeOneShot_property_autorestart: .. rst-class:: classref-property :ref:`bool` **autorestart** = ``false`` .. rst-class:: classref-property-setget - void **set_autorestart** **(** :ref:`bool` value **)** - :ref:`bool` **has_autorestart** **(** **)** If ``true``, the sub-animation will restart automatically after finishing. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_autorestart_delay: .. rst-class:: classref-property :ref:`float` **autorestart_delay** = ``1.0`` .. rst-class:: classref-property-setget - void **set_autorestart_delay** **(** :ref:`float` value **)** - :ref:`float` **get_autorestart_delay** **(** **)** The delay after which the automatic restart is triggered, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_autorestart_random_delay: .. rst-class:: classref-property :ref:`float` **autorestart_random_delay** = ``0.0`` .. rst-class:: classref-property-setget - void **set_autorestart_random_delay** **(** :ref:`float` value **)** - :ref:`float` **get_autorestart_random_delay** **(** **)** If :ref:`autorestart` is ``true``, a random additional delay (in seconds) between 0 and this value will be added to :ref:`autorestart_delay`. .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_fadein_time: .. rst-class:: classref-property :ref:`float` **fadein_time** = ``0.1`` .. rst-class:: classref-property-setget - void **set_fadein_time** **(** :ref:`float` value **)** - :ref:`float` **get_fadein_time** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_fadeout_time: .. rst-class:: classref-property :ref:`float` **fadeout_time** = ``0.1`` .. rst-class:: classref-property-setget - void **set_fadeout_time** **(** :ref:`float` value **)** - :ref:`float` **get_fadeout_time** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_mix_mode: .. rst-class:: classref-property :ref:`MixMode` **mix_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_mix_mode** **(** :ref:`MixMode` value **)** - :ref:`MixMode` **get_mix_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationNodeOneShot_property_sync: .. rst-class:: classref-property :ref:`bool` **sync** = ``false`` .. rst-class:: classref-property-setget - void **set_use_sync** **(** :ref:`bool` value **)** - :ref:`bool` **is_using_sync** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`