: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/doc/classes/SkeletonModification2DPhysicalBones.xml. .. _class_SkeletonModification2DPhysicalBones: SkeletonModification2DPhysicalBones =================================== **Experimental:** Physical bones may be changed in the future to perform the position update of :ref:`Bone2D` on their own, without needing this resource. **Inherits:** :ref:`SkeletonModification2D` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A modification that applies the transforms of :ref:`PhysicalBone2D` nodes to :ref:`Bone2D` nodes. .. rst-class:: classref-introduction-group Description ----------- This modification takes the transforms of :ref:`PhysicalBone2D` nodes and applies them to :ref:`Bone2D` nodes. This allows the :ref:`Bone2D` nodes to react to physics thanks to the linked :ref:`PhysicalBone2D` nodes. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+------------------------------------------------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`physical_bone_chain_length` | ``0`` | +-----------------------+------------------------------------------------------------------------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fetch_physical_bones`\ (\ ) | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_physical_bone_node`\ (\ joint_idx\: :ref:`int`\ ) |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_physical_bone_node`\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`start_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`stop_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length: .. rst-class:: classref-property :ref:`int` **physical_bone_chain_length** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_physical_bone_chain_length**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_physical_bone_chain_length**\ (\ ) The number of :ref:`PhysicalBone2D` nodes linked in this modification. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones: .. rst-class:: classref-method |void| **fetch_physical_bones**\ (\ ) :ref:`🔗` Empties the list of :ref:`PhysicalBone2D` nodes and populates it with all :ref:`PhysicalBone2D` nodes that are children of the :ref:`Skeleton2D`. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node: .. rst-class:: classref-method :ref:`NodePath` **get_physical_bone_node**\ (\ joint_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`PhysicalBone2D` node at ``joint_idx``. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node: .. rst-class:: classref-method |void| **set_physical_bone_node**\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) :ref:`🔗` Sets the :ref:`PhysicalBone2D` node at ``joint_idx``. \ **Note:** This is just the index used for this modification, not the bone index used in the :ref:`Skeleton2D`. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModification2DPhysicalBones_method_start_simulation: .. rst-class:: classref-method |void| **start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Tell the :ref:`PhysicalBone2D` nodes to start simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D` nodes with those names to start simulating. .. rst-class:: classref-item-separator ---- .. _class_SkeletonModification2DPhysicalBones_method_stop_simulation: .. rst-class:: classref-method |void| **stop_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) :ref:`🔗` Tell the :ref:`PhysicalBone2D` nodes to stop simulating and interacting with the physics world. Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D` nodes with those names to stop simulating. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`