class_boneattachment.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the BoneAttachment.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_BoneAttachment:
  6. BoneAttachment
  7. ==============
  8. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. A node that will attach to a bone.
  10. Description
  11. -----------
  12. 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.
  13. Properties
  14. ----------
  15. +-----------------------------+-----------------------------------------------------------+--------+
  16. | :ref:`String<class_String>` | :ref:`bone_name<class_BoneAttachment_property_bone_name>` | ``""`` |
  17. +-----------------------------+-----------------------------------------------------------+--------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_BoneAttachment_property_bone_name:
  21. - :ref:`String<class_String>` **bone_name**
  22. +-----------+----------------------+
  23. | *Default* | ``""`` |
  24. +-----------+----------------------+
  25. | *Setter* | set_bone_name(value) |
  26. +-----------+----------------------+
  27. | *Getter* | get_bone_name() |
  28. +-----------+----------------------+
  29. The name of the attached bone.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`