Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_skeletonmodification2dphysicalbones.rst

class_skeletonmodification2dphysicalbones.rst 8.8 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonModification2DPhysicalBones.xml.
    7. 

  7. 

  8. .. _class_SkeletonModification2DPhysicalBones:
    9. 

  9. 

  10. SkeletonModification2DPhysicalBones
    11. 

  11. ===================================
    12. 

  12. 

  13. **Experimental:** Physical bones may be changed in the future to perform the position update of :ref:`Bone2D<class_Bone2D>` on their own, without needing this resource.
    14. 

  14. 

  15. **Inherits:** :ref:`SkeletonModification2D<class_SkeletonModification2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    16. 

  16. 

  17. A modification that applies the transforms of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to :ref:`Bone2D<class_Bone2D>` nodes.
    18. 

  18. 

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

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. This modification takes the transforms of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes and applies them to :ref:`Bone2D<class_Bone2D>` nodes. This allows the :ref:`Bone2D<class_Bone2D>` nodes to react to physics thanks to the linked :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes.
    25. 

  25. 

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

  27. 

  28. Properties
    29. 

  29. ----------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

  34.    +-----------------------+------------------------------------------------------------------------------------------------------------------+-------+
    35. 

  35.    | :ref:`int<class_int>` | :ref:`physical_bone_chain_length<class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length>` | ``0`` |
    36. 

  36.    +-----------------------+------------------------------------------------------------------------------------------------------------------+-------+
    37. 

  37. 

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

  39. 

  40. Methods
    41. 

  41. -------
    42. 

  42. 

  43. .. table::
    44. 

  44.    :widths: auto
    45. 

  45. 

  46.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | |void|                          | :ref:`fetch_physical_bones<class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones>`\ (\ )                                                                                               |
    48. 

  48.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`NodePath<class_NodePath>` | :ref:`get_physical_bone_node<class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node>`\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const|                                                |
    50. 

  50.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | |void|                          | :ref:`set_physical_bone_node<class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node>`\ (\ joint_idx\: :ref:`int<class_int>`, physicalbone2d_node\: :ref:`NodePath<class_NodePath>`\ ) |
    52. 

  52.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | |void|                          | :ref:`start_simulation<class_SkeletonModification2DPhysicalBones_method_start_simulation>`\ (\ bones\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ )                        |
    54. 

  54.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55.    | |void|                          | :ref:`stop_simulation<class_SkeletonModification2DPhysicalBones_method_stop_simulation>`\ (\ bones\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ )                          |
    56. 

  56.    +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. 

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

  59. 

  60. ----
    61. 

  61. 

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

  63. 

  64. Property Descriptions
    65. 

  65. ---------------------
    66. 

  66. 

  67. .. _class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length:
    68. 

  68. 

  69. .. rst-class:: classref-property
    70. 

  70. 

  71. :ref:`int<class_int>` **physical_bone_chain_length** = ``0`` :ref:`🔗<class_SkeletonModification2DPhysicalBones_property_physical_bone_chain_length>`
    72. 

  72. 

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

  74. 

  75. - |void| **set_physical_bone_chain_length**\ (\ value\: :ref:`int<class_int>`\ )
    76. 

  76. - :ref:`int<class_int>` **get_physical_bone_chain_length**\ (\ )
    77. 

  77. 

  78. The number of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes linked in this modification.
    79. 

  79. 

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

  81. 

  82. ----
    83. 

  83. 

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

  85. 

  86. Method Descriptions
    87. 

  87. -------------------
    88. 

  88. 

  89. .. _class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones:
    90. 

  90. 

  91. .. rst-class:: classref-method
    92. 

  92. 

  93. |void| **fetch_physical_bones**\ (\ ) :ref:`🔗<class_SkeletonModification2DPhysicalBones_method_fetch_physical_bones>`
    94. 

  94. 

  95. Empties the list of :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes and populates it with all :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes that are children of the :ref:`Skeleton2D<class_Skeleton2D>`.
    96. 

  96. 

  97. .. rst-class:: classref-item-separator
    98. 

  98. 

  99. ----
    100. 

  100. 

  101. .. _class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node:
    102. 

  102. 

  103. .. rst-class:: classref-method
    104. 

  104. 

  105. :ref:`NodePath<class_NodePath>` **get_physical_bone_node**\ (\ joint_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SkeletonModification2DPhysicalBones_method_get_physical_bone_node>`
    106. 

  106. 

  107. Returns the :ref:`PhysicalBone2D<class_PhysicalBone2D>` node at ``joint_idx``.
    108. 

  108. 

  109. .. rst-class:: classref-item-separator
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node:
    114. 

  114. 

  115. .. rst-class:: classref-method
    116. 

  116. 

  117. |void| **set_physical_bone_node**\ (\ joint_idx\: :ref:`int<class_int>`, physicalbone2d_node\: :ref:`NodePath<class_NodePath>`\ ) :ref:`🔗<class_SkeletonModification2DPhysicalBones_method_set_physical_bone_node>`
    118. 

  118. 

  119. Sets the :ref:`PhysicalBone2D<class_PhysicalBone2D>` node at ``joint_idx``.
    120. 

  120. 

  121. \ **Note:** This is just the index used for this modification, not the bone index used in the :ref:`Skeleton2D<class_Skeleton2D>`.
    122. 

  122. 

  123. .. rst-class:: classref-item-separator
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_SkeletonModification2DPhysicalBones_method_start_simulation:
    128. 

  128. 

  129. .. rst-class:: classref-method
    130. 

  130. 

  131. |void| **start_simulation**\ (\ bones\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) :ref:`🔗<class_SkeletonModification2DPhysicalBones_method_start_simulation>`
    132. 

  132. 

  133. Tell the :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to start simulating and interacting with the physics world.
    134. 

  134. 

  135. Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes with those names to start simulating.
    136. 

  136. 

  137. .. rst-class:: classref-item-separator
    138. 

  138. 

  139. ----
    140. 

  140. 

  141. .. _class_SkeletonModification2DPhysicalBones_method_stop_simulation:
    142. 

  142. 

  143. .. rst-class:: classref-method
    144. 

  144. 

  145. |void| **stop_simulation**\ (\ bones\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) :ref:`🔗<class_SkeletonModification2DPhysicalBones_method_stop_simulation>`
    146. 

  146. 

  147. Tell the :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes to stop simulating and interacting with the physics world.
    148. 

  148. 

  149. Optionally, an array of bone names can be passed to this function, and that will cause only :ref:`PhysicalBone2D<class_PhysicalBone2D>` nodes with those names to stop simulating.
    150. 

  150. 

  151. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    152. 

  152. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    153. 

  153. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    154. 

  154. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    155. 

  155. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    156. 

  156. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    157. 

  157. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    158. 

  158. .. |void| replace:: :abbr:`void (No return value.)`
    159. 

  159.