:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/SkeletonModificationStack2D.xml. .. _class_SkeletonModificationStack2D: SkeletonModificationStack2D =========================== **Experimental:** This class may be changed or removed in future versions. **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A resource that holds a stack of :ref:`SkeletonModification2D`\ s. .. rst-class:: classref-introduction-group Description ----------- This resource is used by the Skeleton and holds a stack of :ref:`SkeletonModification2D`\ s. This controls the order of the modifications and how they are applied. Modification order is especially important for full-body IK setups, as you need to execute the modifications in the correct order to get the desired results. For example, you want to execute a modification on the spine *before* the arms on a humanoid skeleton. This resource also controls how strongly all of the modifications are applied to the :ref:`Skeleton2D`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`enabled` | ``false`` | +---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`modification_count` | ``0`` | +---------------------------+------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`strength` | ``1.0`` | +---------------------------+------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_modification`\ (\ modification\: :ref:`SkeletonModification2D`\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`delete_modification`\ (\ mod_idx\: :ref:`int`\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`enable_all_modifications`\ (\ enabled\: :ref:`bool`\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`execute`\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_setup`\ (\ ) |const| | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SkeletonModification2D` | :ref:`get_modification`\ (\ mod_idx\: :ref:`int`\ ) |const| | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Skeleton2D` | :ref:`get_skeleton`\ (\ ) |const| | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_modification`\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`setup`\ (\ ) | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SkeletonModificationStack2D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_enabled**\ (\ ) If ``true``, the modification's in the stack will be called. This is handled automatically through the :ref:`Skeleton2D` node. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_property_modification_count: .. rst-class:: classref-property :ref:`int` **modification_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_modification_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_modification_count**\ (\ ) The number of modifications in the stack. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_property_strength: .. rst-class:: classref-property :ref:`float` **strength** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_strength**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_strength**\ (\ ) The interpolation strength of the modifications in stack. A value of ``0`` will make it where the modifications are not applied, a strength of ``0.5`` will be half applied, and a strength of ``1`` will allow the modifications to be fully applied and override the :ref:`Skeleton2D` :ref:`Bone2D` poses. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SkeletonModificationStack2D_method_add_modification: .. rst-class:: classref-method |void| **add_modification**\ (\ modification\: :ref:`SkeletonModification2D`\ ) :ref:`🔗` Adds the passed-in :ref:`SkeletonModification2D` to the stack. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_delete_modification: .. rst-class:: classref-method |void| **delete_modification**\ (\ mod_idx\: :ref:`int`\ ) :ref:`🔗` Deletes the :ref:`SkeletonModification2D` at the index position ``mod_idx``, if it exists. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_enable_all_modifications: .. rst-class:: classref-method |void| **enable_all_modifications**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` Enables all :ref:`SkeletonModification2D`\ s in the stack. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_execute: .. rst-class:: classref-method |void| **execute**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) :ref:`🔗` Executes all of the :ref:`SkeletonModification2D`\ s in the stack that use the same execution mode as the passed-in ``execution_mode``, starting from index ``0`` to :ref:`modification_count`. \ **Note:** The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_get_is_setup: .. rst-class:: classref-method :ref:`bool` **get_is_setup**\ (\ ) |const| :ref:`🔗` Returns a boolean that indicates whether the modification stack is setup and can execute. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_get_modification: .. rst-class:: classref-method :ref:`SkeletonModification2D` **get_modification**\ (\ mod_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`SkeletonModification2D` at the passed-in index, ``mod_idx``. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_get_skeleton: .. rst-class:: classref-method :ref:`Skeleton2D` **get_skeleton**\ (\ ) |const| :ref:`🔗` Returns the :ref:`Skeleton2D` node that the SkeletonModificationStack2D is bound to. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_set_modification: .. rst-class:: classref-method |void| **set_modification**\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) :ref:`🔗` Sets the modification at ``mod_idx`` to the passed-in modification, ``modification``. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModificationStack2D_method_setup: .. rst-class:: classref-method |void| **setup**\ (\ ) :ref:`🔗` Sets up the modification stack so it can execute. This function should be called by :ref:`Skeleton2D` and shouldn't be manually called unless you know what you are doing. .. |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.)`