class_gltfskeleton.rst 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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 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. Description
  10. -----------
  11. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to ``GLTFSkeleton`` within a script will cause an error in an exported project.
  12. Properties
  13. ----------
  14. +-----------------------------------------+---------------------------------------------------+----------------------+
  15. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`joints<class_GLTFSkeleton_property_joints>` | ``PoolIntArray( )`` |
  16. +-----------------------------------------+---------------------------------------------------+----------------------+
  17. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`roots<class_GLTFSkeleton_property_roots>` | ``PoolIntArray( )`` |
  18. +-----------------------------------------+---------------------------------------------------+----------------------+
  19. Methods
  20. -------
  21. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`BoneAttachment<class_BoneAttachment>` | :ref:`get_bone_attachment<class_GLTFSkeleton_method_get_bone_attachment>` **(** :ref:`int<class_int>` idx **)** |
  23. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`int<class_int>` | :ref:`get_bone_attachment_count<class_GLTFSkeleton_method_get_bone_attachment_count>` **(** **)** |
  25. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_godot_bone_node<class_GLTFSkeleton_method_get_godot_bone_node>` **(** **)** |
  27. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`Skeleton<class_Skeleton>` | :ref:`get_godot_skeleton<class_GLTFSkeleton_method_get_godot_skeleton>` **(** **)** |
  29. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`Array<class_Array>` | :ref:`get_unique_names<class_GLTFSkeleton_method_get_unique_names>` **(** **)** |
  31. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_godot_bone_node<class_GLTFSkeleton_method_set_godot_bone_node>` **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)** |
  33. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`set_unique_names<class_GLTFSkeleton_method_set_unique_names>` **(** :ref:`Array<class_Array>` unique_names **)** |
  35. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  36. Property Descriptions
  37. ---------------------
  38. .. _class_GLTFSkeleton_property_joints:
  39. - :ref:`PoolIntArray<class_PoolIntArray>` **joints**
  40. +-----------+----------------------+
  41. | *Default* | ``PoolIntArray( )`` |
  42. +-----------+----------------------+
  43. | *Setter* | set_joints(value) |
  44. +-----------+----------------------+
  45. | *Getter* | get_joints() |
  46. +-----------+----------------------+
  47. ----
  48. .. _class_GLTFSkeleton_property_roots:
  49. - :ref:`PoolIntArray<class_PoolIntArray>` **roots**
  50. +-----------+----------------------+
  51. | *Default* | ``PoolIntArray( )`` |
  52. +-----------+----------------------+
  53. | *Setter* | set_roots(value) |
  54. +-----------+----------------------+
  55. | *Getter* | get_roots() |
  56. +-----------+----------------------+
  57. Method Descriptions
  58. -------------------
  59. .. _class_GLTFSkeleton_method_get_bone_attachment:
  60. - :ref:`BoneAttachment<class_BoneAttachment>` **get_bone_attachment** **(** :ref:`int<class_int>` idx **)**
  61. ----
  62. .. _class_GLTFSkeleton_method_get_bone_attachment_count:
  63. - :ref:`int<class_int>` **get_bone_attachment_count** **(** **)**
  64. ----
  65. .. _class_GLTFSkeleton_method_get_godot_bone_node:
  66. - :ref:`Dictionary<class_Dictionary>` **get_godot_bone_node** **(** **)**
  67. ----
  68. .. _class_GLTFSkeleton_method_get_godot_skeleton:
  69. - :ref:`Skeleton<class_Skeleton>` **get_godot_skeleton** **(** **)**
  70. ----
  71. .. _class_GLTFSkeleton_method_get_unique_names:
  72. - :ref:`Array<class_Array>` **get_unique_names** **(** **)**
  73. ----
  74. .. _class_GLTFSkeleton_method_set_godot_bone_node:
  75. - void **set_godot_bone_node** **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)**
  76. ----
  77. .. _class_GLTFSkeleton_method_set_unique_names:
  78. - void **set_unique_names** **(** :ref:`Array<class_Array>` unique_names **)**
  79. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  80. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  81. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`