class_modifierbonetarget3d.rst 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ModifierBoneTarget3D.xml.
  6. .. _class_ModifierBoneTarget3D:
  7. ModifierBoneTarget3D
  8. ====================
  9. **Inherits:** :ref:`SkeletonModifier3D<class_SkeletonModifier3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. А node that dynamically copies the 3D transform of a bone in its parent :ref:`Skeleton3D<class_Skeleton3D>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. This node selects a bone in a :ref:`Skeleton3D<class_Skeleton3D>` and attaches to it. This means that the **ModifierBoneTarget3D** node will dynamically copy the 3D transform of the selected bone.
  15. The functionality is similar to :ref:`BoneAttachment3D<class_BoneAttachment3D>`, but this node adopts the :ref:`SkeletonModifier3D<class_SkeletonModifier3D>` cycle and is intended to be used as another :ref:`SkeletonModifier3D<class_SkeletonModifier3D>`'s target.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------+-----------------------------------------------------------------+--------+
  22. | :ref:`int<class_int>` | :ref:`bone<class_ModifierBoneTarget3D_property_bone>` | ``-1`` |
  23. +-----------------------------+-----------------------------------------------------------------+--------+
  24. | :ref:`String<class_String>` | :ref:`bone_name<class_ModifierBoneTarget3D_property_bone_name>` | ``""`` |
  25. +-----------------------------+-----------------------------------------------------------------+--------+
  26. .. rst-class:: classref-section-separator
  27. ----
  28. .. rst-class:: classref-descriptions-group
  29. Property Descriptions
  30. ---------------------
  31. .. _class_ModifierBoneTarget3D_property_bone:
  32. .. rst-class:: classref-property
  33. :ref:`int<class_int>` **bone** = ``-1`` :ref:`🔗<class_ModifierBoneTarget3D_property_bone>`
  34. .. rst-class:: classref-property-setget
  35. - |void| **set_bone**\ (\ value\: :ref:`int<class_int>`\ )
  36. - :ref:`int<class_int>` **get_bone**\ (\ )
  37. The index of the attached bone.
  38. .. rst-class:: classref-item-separator
  39. ----
  40. .. _class_ModifierBoneTarget3D_property_bone_name:
  41. .. rst-class:: classref-property
  42. :ref:`String<class_String>` **bone_name** = ``""`` :ref:`🔗<class_ModifierBoneTarget3D_property_bone_name>`
  43. .. rst-class:: classref-property-setget
  44. - |void| **set_bone_name**\ (\ value\: :ref:`String<class_String>`\ )
  45. - :ref:`String<class_String>` **get_bone_name**\ (\ )
  46. The name of the attached bone.
  47. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  48. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  49. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  50. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  51. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  52. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  53. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  54. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  55. .. |void| replace:: :abbr:`void (No return value.)`