class_boneattachment.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the BoneAttachment.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_BoneAttachment:
  5. BoneAttachment
  6. ==============
  7. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A node that will attach to a bone.
  12. Member Functions
  13. ----------------
  14. +------------------------------+------------------------------------------------------------------------------------------------------------+
  15. | :ref:`String<class_string>` | :ref:`get_bone_name<class_BoneAttachment_get_bone_name>` **(** **)** const |
  16. +------------------------------+------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_bone_name<class_BoneAttachment_set_bone_name>` **(** :ref:`String<class_string>` bone_name **)** |
  18. +------------------------------+------------------------------------------------------------------------------------------------------------+
  19. Description
  20. -----------
  21. This node must be the child of a :ref:`Skeleton<class_skeleton>` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.
  22. Member Function Description
  23. ---------------------------
  24. .. _class_BoneAttachment_get_bone_name:
  25. - :ref:`String<class_string>` **get_bone_name** **(** **)** const
  26. Returns the name of the bone node attached to.
  27. .. _class_BoneAttachment_set_bone_name:
  28. - void **set_bone_name** **(** :ref:`String<class_string>` bone_name **)**
  29. Changes the name of the bone node