Etusivu Tutki Apua
Kirjaudu sisään
godotengine
/
godot-docs
peilaus alkaen https://github.com/godotengine/godot-docs
Tarkkaile 1
Äänestä 1
Fork 0
Tiedostot
Branch: classref/sync-c6d130a
Branchit Tagit
godot-docs
/
classes
/
class_boneattachment3d.rst

class_boneattachment3d.rst 9.8 KB
Pysyvä linkki Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193 
  1. :github_url: hide
    2. 

  2. 

  3. .. meta::
    4. 

  4. 	:keywords: tag
    5. 

  5. 

  6. .. DO NOT EDIT THIS FILE!!!
    7. 

  7. .. Generated automatically from Godot engine sources.
    8. 

  8. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    9. 

  9. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneAttachment3D.xml.
    10. 

  10. 

  11. .. _class_BoneAttachment3D:
    12. 

  12. 

  13. BoneAttachment3D
    14. 

  14. ================
    15. 

  15. 

  16. **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    17. 

  17. 

  18. А node that dynamically copies or overrides the 3D transform of a bone in its parent :ref:`Skeleton3D<class_Skeleton3D>`.
    19. 

  19. 

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

  21. 

  22. Description
    23. 

  23. -----------
    24. 

  24. 

  25. This node selects a bone in a :ref:`Skeleton3D<class_Skeleton3D>` and attaches to it. This means that the **BoneAttachment3D** node will either dynamically copy or override the 3D transform of the selected bone.
    26. 

  26. 

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

  28. 

  29. Properties
    30. 

  30. ----------
    31. 

  31. 

  32. .. table::
    33. 

  33.    :widths: auto
    34. 

  34. 

  35.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    36. 

  36.    | :ref:`int<class_int>`                                               | :ref:`bone_idx<class_BoneAttachment3D_property_bone_idx>`                           | ``-1``                                                                        |
    37. 

  37.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    38. 

  38.    | :ref:`String<class_String>`                                         | :ref:`bone_name<class_BoneAttachment3D_property_bone_name>`                         | ``""``                                                                        |
    39. 

  39.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    40. 

  40.    | :ref:`NodePath<class_NodePath>`                                     | :ref:`external_skeleton<class_BoneAttachment3D_property_external_skeleton>`         |                                                                               |
    41. 

  41.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    42. 

  42.    | :ref:`bool<class_bool>`                                             | :ref:`override_pose<class_BoneAttachment3D_property_override_pose>`                 | ``false``                                                                     |
    43. 

  43.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    44. 

  44.    | :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` | physics_interpolation_mode                                                          | ``2`` (overrides :ref:`Node<class_Node_property_physics_interpolation_mode>`) |
    45. 

  45.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    46. 

  46.    | :ref:`bool<class_bool>`                                             | :ref:`use_external_skeleton<class_BoneAttachment3D_property_use_external_skeleton>` | ``false``                                                                     |
    47. 

  47.    +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    48. 

  48. 

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

  50. 

  51. Methods
    52. 

  52. -------
    53. 

  53. 

  54. .. table::
    55. 

  55.    :widths: auto
    56. 

  56. 

  57.    +-------------------------------------+-----------------------------------------------------------------------------------+
    58. 

  58.    | :ref:`Skeleton3D<class_Skeleton3D>` | :ref:`get_skeleton<class_BoneAttachment3D_method_get_skeleton>`\ (\ )             |
    59. 

  59.    +-------------------------------------+-----------------------------------------------------------------------------------+
    60. 

  60.    | |void|                              | :ref:`on_skeleton_update<class_BoneAttachment3D_method_on_skeleton_update>`\ (\ ) |
    61. 

  61.    +-------------------------------------+-----------------------------------------------------------------------------------+
    62. 

  62. 

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

  64. 

  65. ----
    66. 

  66. 

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

  68. 

  69. Property Descriptions
    70. 

  70. ---------------------
    71. 

  71. 

  72. .. _class_BoneAttachment3D_property_bone_idx:
    73. 

  73. 

  74. .. rst-class:: classref-property
    75. 

  75. 

  76. :ref:`int<class_int>` **bone_idx** = ``-1`` :ref:`🔗<class_BoneAttachment3D_property_bone_idx>`
    77. 

  77. 

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

  79. 

  80. - |void| **set_bone_idx**\ (\ value\: :ref:`int<class_int>`\ )
    81. 

  81. - :ref:`int<class_int>` **get_bone_idx**\ (\ )
    82. 

  82. 

  83. The index of the attached bone.
    84. 

  84. 

  85. .. rst-class:: classref-item-separator
    86. 

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_BoneAttachment3D_property_bone_name:
    90. 

  90. 

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

  92. 

  93. :ref:`String<class_String>` **bone_name** = ``""`` :ref:`🔗<class_BoneAttachment3D_property_bone_name>`
    94. 

  94. 

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

  96. 

  97. - |void| **set_bone_name**\ (\ value\: :ref:`String<class_String>`\ )
    98. 

  98. - :ref:`String<class_String>` **get_bone_name**\ (\ )
    99. 

  99. 

  100. The name of the attached bone.
    101. 

  101. 

  102. .. rst-class:: classref-item-separator
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_BoneAttachment3D_property_external_skeleton:
    107. 

  107. 

  108. .. rst-class:: classref-property
    109. 

  109. 

  110. :ref:`NodePath<class_NodePath>` **external_skeleton** :ref:`🔗<class_BoneAttachment3D_property_external_skeleton>`
    111. 

  111. 

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

  113. 

  114. - |void| **set_external_skeleton**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
    115. 

  115. - :ref:`NodePath<class_NodePath>` **get_external_skeleton**\ (\ )
    116. 

  116. 

  117. The :ref:`NodePath<class_NodePath>` to the external :ref:`Skeleton3D<class_Skeleton3D>` node.
    118. 

  118. 

  119. .. rst-class:: classref-item-separator
    120. 

  120. 

  121. ----
    122. 

  122. 

  123. .. _class_BoneAttachment3D_property_override_pose:
    124. 

  124. 

  125. .. rst-class:: classref-property
    126. 

  126. 

  127. :ref:`bool<class_bool>` **override_pose** = ``false`` :ref:`🔗<class_BoneAttachment3D_property_override_pose>`
    128. 

  128. 

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

  130. 

  131. - |void| **set_override_pose**\ (\ value\: :ref:`bool<class_bool>`\ )
    132. 

  132. - :ref:`bool<class_bool>` **get_override_pose**\ (\ )
    133. 

  133. 

  134. Whether the **BoneAttachment3D** node will override the bone pose of the bone it is attached to. When set to ``true``, the **BoneAttachment3D** node can change the pose of the bone. When set to ``false``, the **BoneAttachment3D** will always be set to the bone's transform.
    135. 

  135. 

  136. \ **Note:** This override performs interruptively in the skeleton update process using signals due to the old design. It may cause unintended behavior when used at the same time with :ref:`SkeletonModifier3D<class_SkeletonModifier3D>`.
    137. 

  137. 

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

  139. 

  140. ----
    141. 

  141. 

  142. .. _class_BoneAttachment3D_property_use_external_skeleton:
    143. 

  143. 

  144. .. rst-class:: classref-property
    145. 

  145. 

  146. :ref:`bool<class_bool>` **use_external_skeleton** = ``false`` :ref:`🔗<class_BoneAttachment3D_property_use_external_skeleton>`
    147. 

  147. 

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

  149. 

  150. - |void| **set_use_external_skeleton**\ (\ value\: :ref:`bool<class_bool>`\ )
    151. 

  151. - :ref:`bool<class_bool>` **get_use_external_skeleton**\ (\ )
    152. 

  152. 

  153. Whether the **BoneAttachment3D** node will use an external :ref:`Skeleton3D<class_Skeleton3D>` node rather than attempting to use its parent node as the :ref:`Skeleton3D<class_Skeleton3D>`. When set to ``true``, the **BoneAttachment3D** node will use the external :ref:`Skeleton3D<class_Skeleton3D>` node set in :ref:`external_skeleton<class_BoneAttachment3D_property_external_skeleton>`.
    154. 

  154. 

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

  156. 

  157. ----
    158. 

  158. 

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

  160. 

  161. Method Descriptions
    162. 

  162. -------------------
    163. 

  163. 

  164. .. _class_BoneAttachment3D_method_get_skeleton:
    165. 

  165. 

  166. .. rst-class:: classref-method
    167. 

  167. 

  168. :ref:`Skeleton3D<class_Skeleton3D>` **get_skeleton**\ (\ ) :ref:`🔗<class_BoneAttachment3D_method_get_skeleton>`
    169. 

  169. 

  170. Returns the parent or external :ref:`Skeleton3D<class_Skeleton3D>` node if it exists, otherwise returns ``null``.
    171. 

  171. 

  172. .. rst-class:: classref-item-separator
    173. 

  173. 

  174. ----
    175. 

  175. 

  176. .. _class_BoneAttachment3D_method_on_skeleton_update:
    177. 

  177. 

  178. .. rst-class:: classref-method
    179. 

  179. 

  180. |void| **on_skeleton_update**\ (\ ) :ref:`🔗<class_BoneAttachment3D_method_on_skeleton_update>`
    181. 

  181. 

  182. A function that is called automatically when the :ref:`Skeleton3D<class_Skeleton3D>` is updated. This function is where the **BoneAttachment3D** node updates its position so it is correctly bound when it is *not* set to override the bone pose.
    183. 

  183. 

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

  185. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
    186. 

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

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

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

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

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

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

  192. .. |void| replace:: :abbr:`void (No return value.)`
    193. 

  193.