class_gltfskeleton.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the GLTFSkeleton.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_GLTFSkeleton:
  6. GLTFSkeleton
  7. ============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-----------------------------------------+---------------------------------------------------+----------------------+
  12. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`joints<class_GLTFSkeleton_property_joints>` | ``PoolIntArray( )`` |
  13. +-----------------------------------------+---------------------------------------------------+----------------------+
  14. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`roots<class_GLTFSkeleton_property_roots>` | ``PoolIntArray( )`` |
  15. +-----------------------------------------+---------------------------------------------------+----------------------+
  16. Methods
  17. -------
  18. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`BoneAttachment<class_BoneAttachment>` | :ref:`get_bone_attachment<class_GLTFSkeleton_method_get_bone_attachment>` **(** :ref:`int<class_int>` idx **)** |
  20. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_bone_attachment_count<class_GLTFSkeleton_method_get_bone_attachment_count>` **(** **)** |
  22. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_godot_bone_node<class_GLTFSkeleton_method_get_godot_bone_node>` **(** **)** |
  24. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Skeleton<class_Skeleton>` | :ref:`get_godot_skeleton<class_GLTFSkeleton_method_get_godot_skeleton>` **(** **)** |
  26. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Array<class_Array>` | :ref:`get_unique_names<class_GLTFSkeleton_method_get_unique_names>` **(** **)** |
  28. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_godot_bone_node<class_GLTFSkeleton_method_set_godot_bone_node>` **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)** |
  30. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`set_unique_names<class_GLTFSkeleton_method_set_unique_names>` **(** :ref:`Array<class_Array>` unique_names **)** |
  32. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  33. Property Descriptions
  34. ---------------------
  35. .. _class_GLTFSkeleton_property_joints:
  36. - :ref:`PoolIntArray<class_PoolIntArray>` **joints**
  37. +-----------+----------------------+
  38. | *Default* | ``PoolIntArray( )`` |
  39. +-----------+----------------------+
  40. | *Setter* | set_joints(value) |
  41. +-----------+----------------------+
  42. | *Getter* | get_joints() |
  43. +-----------+----------------------+
  44. ----
  45. .. _class_GLTFSkeleton_property_roots:
  46. - :ref:`PoolIntArray<class_PoolIntArray>` **roots**
  47. +-----------+----------------------+
  48. | *Default* | ``PoolIntArray( )`` |
  49. +-----------+----------------------+
  50. | *Setter* | set_roots(value) |
  51. +-----------+----------------------+
  52. | *Getter* | get_roots() |
  53. +-----------+----------------------+
  54. Method Descriptions
  55. -------------------
  56. .. _class_GLTFSkeleton_method_get_bone_attachment:
  57. - :ref:`BoneAttachment<class_BoneAttachment>` **get_bone_attachment** **(** :ref:`int<class_int>` idx **)**
  58. ----
  59. .. _class_GLTFSkeleton_method_get_bone_attachment_count:
  60. - :ref:`int<class_int>` **get_bone_attachment_count** **(** **)**
  61. ----
  62. .. _class_GLTFSkeleton_method_get_godot_bone_node:
  63. - :ref:`Dictionary<class_Dictionary>` **get_godot_bone_node** **(** **)**
  64. ----
  65. .. _class_GLTFSkeleton_method_get_godot_skeleton:
  66. - :ref:`Skeleton<class_Skeleton>` **get_godot_skeleton** **(** **)**
  67. ----
  68. .. _class_GLTFSkeleton_method_get_unique_names:
  69. - :ref:`Array<class_Array>` **get_unique_names** **(** **)**
  70. ----
  71. .. _class_GLTFSkeleton_method_set_godot_bone_node:
  72. - void **set_godot_bone_node** **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)**
  73. ----
  74. .. _class_GLTFSkeleton_method_set_unique_names:
  75. - void **set_unique_names** **(** :ref:`Array<class_Array>` unique_names **)**
  76. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  77. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  78. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`