pandemonium_engine_docs/classes/class_gltfskeleton.rst

125 lines
6.1 KiB
ReStructuredText
Raw Normal View History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFSkeleton.xml.
.. _class_GLTFSkeleton:
GLTFSkeleton
============
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Description
-----------
**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.
Properties
----------
+-----------------------------------------+---------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`joints<class_GLTFSkeleton_property_joints>` | ``PoolIntArray( )`` |
+-----------------------------------------+---------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`roots<class_GLTFSkeleton_property_roots>` | ``PoolIntArray( )`` |
+-----------------------------------------+---------------------------------------------------+----------------------+
Methods
-------
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BoneAttachment<class_BoneAttachment>` | :ref:`get_bone_attachment<class_GLTFSkeleton_method_get_bone_attachment>` **(** :ref:`int<class_int>` idx **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bone_attachment_count<class_GLTFSkeleton_method_get_bone_attachment_count>` **(** **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_godot_bone_node<class_GLTFSkeleton_method_get_godot_bone_node>` **(** **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Skeleton<class_Skeleton>` | :ref:`get_godot_skeleton<class_GLTFSkeleton_method_get_godot_skeleton>` **(** **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_unique_names<class_GLTFSkeleton_method_get_unique_names>` **(** **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_godot_bone_node<class_GLTFSkeleton_method_set_godot_bone_node>` **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_unique_names<class_GLTFSkeleton_method_set_unique_names>` **(** :ref:`Array<class_Array>` unique_names **)** |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_GLTFSkeleton_property_joints:
- :ref:`PoolIntArray<class_PoolIntArray>` **joints**
+-----------+----------------------+
| *Default* | ``PoolIntArray( )`` |
+-----------+----------------------+
| *Setter* | set_joints(value) |
+-----------+----------------------+
| *Getter* | get_joints() |
+-----------+----------------------+
----
.. _class_GLTFSkeleton_property_roots:
- :ref:`PoolIntArray<class_PoolIntArray>` **roots**
+-----------+----------------------+
| *Default* | ``PoolIntArray( )`` |
+-----------+----------------------+
| *Setter* | set_roots(value) |
+-----------+----------------------+
| *Getter* | get_roots() |
+-----------+----------------------+
Method Descriptions
-------------------
.. _class_GLTFSkeleton_method_get_bone_attachment:
- :ref:`BoneAttachment<class_BoneAttachment>` **get_bone_attachment** **(** :ref:`int<class_int>` idx **)**
----
.. _class_GLTFSkeleton_method_get_bone_attachment_count:
- :ref:`int<class_int>` **get_bone_attachment_count** **(** **)**
----
.. _class_GLTFSkeleton_method_get_godot_bone_node:
- :ref:`Dictionary<class_Dictionary>` **get_godot_bone_node** **(** **)**
----
.. _class_GLTFSkeleton_method_get_godot_skeleton:
- :ref:`Skeleton<class_Skeleton>` **get_godot_skeleton** **(** **)**
----
.. _class_GLTFSkeleton_method_get_unique_names:
- :ref:`Array<class_Array>` **get_unique_names** **(** **)**
----
.. _class_GLTFSkeleton_method_set_godot_bone_node:
- void **set_godot_bone_node** **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)**
----
.. _class_GLTFSkeleton_method_set_unique_names:
- void **set_unique_names** **(** :ref:`Array<class_Array>` unique_names **)**
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`