godot-docs/classes/class_gltfstate.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFState.xml.

.. _class_GLTFState:

GLTFState
=========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`



Properties
----------

+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`String<class_String>`                     | :ref:`base_path<class_GLTFState_property_base_path>`                       | ``""``                 |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`PackedByteArray[]<class_PackedByteArray>` | :ref:`buffers<class_GLTFState_property_buffers>`                           | ``[]``                 |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`bool<class_bool>`                         | :ref:`create_animations<class_GLTFState_property_create_animations>`       | ``true``               |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>`   | :ref:`glb_data<class_GLTFState_property_glb_data>`                         | ``PackedByteArray()``  |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`Dictionary<class_Dictionary>`             | :ref:`json<class_GLTFState_property_json>`                                 | ``{}``                 |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`int<class_int>`                           | :ref:`major_version<class_GLTFState_property_major_version>`               | ``0``                  |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`int<class_int>`                           | :ref:`minor_version<class_GLTFState_property_minor_version>`               | ``0``                  |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`root_nodes<class_GLTFState_property_root_nodes>`                     | ``PackedInt32Array()`` |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`String<class_String>`                     | :ref:`scene_name<class_GLTFState_property_scene_name>`                     | ``""``                 |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
| :ref:`bool<class_bool>`                         | :ref:`use_named_skin_binds<class_GLTFState_property_use_named_skin_binds>` | ``false``              |
+-------------------------------------------------+----------------------------------------------------------------------------+------------------------+

Methods
-------

+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFAccessor[]<class_GLTFAccessor>`     | :ref:`get_accessors<class_GLTFState_method_get_accessors>` **(** **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AnimationPlayer<class_AnimationPlayer>` | :ref:`get_animation_player<class_GLTFState_method_get_animation_player>` **(** :ref:`int<class_int>` idx **)**                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`get_animation_players_count<class_GLTFState_method_get_animation_players_count>` **(** :ref:`int<class_int>` idx **)**                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFAnimation[]<class_GLTFAnimation>`   | :ref:`get_animations<class_GLTFState_method_get_animations>` **(** **)**                                                                              |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFBufferView[]<class_GLTFBufferView>` | :ref:`get_buffer_views<class_GLTFState_method_get_buffer_views>` **(** **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFCamera[]<class_GLTFCamera>`         | :ref:`get_cameras<class_GLTFState_method_get_cameras>` **(** **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D[]<class_Texture2D>`           | :ref:`get_images<class_GLTFState_method_get_images>` **(** **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFLight[]<class_GLTFLight>`           | :ref:`get_lights<class_GLTFState_method_get_lights>` **(** **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` | :ref:`get_materials<class_GLTFState_method_get_materials>` **(** **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFMesh[]<class_GLTFMesh>`             | :ref:`get_meshes<class_GLTFState_method_get_meshes>` **(** **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFNode[]<class_GLTFNode>`             | :ref:`get_nodes<class_GLTFState_method_get_nodes>` **(** **)**                                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_Node>`                       | :ref:`get_scene_node<class_GLTFState_method_get_scene_node>` **(** :ref:`int<class_int>` idx **)**                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>`           | :ref:`get_skeleton_to_node<class_GLTFState_method_get_skeleton_to_node>` **(** **)**                                                                  |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFSkeleton[]<class_GLTFSkeleton>`     | :ref:`get_skeletons<class_GLTFState_method_get_skeletons>` **(** **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFSkin[]<class_GLTFSkin>`             | :ref:`get_skins<class_GLTFState_method_get_skins>` **(** **)**                                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GLTFTexture[]<class_GLTFTexture>`       | :ref:`get_textures<class_GLTFState_method_get_textures>` **(** **)**                                                                                  |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String[]<class_String>`                 | :ref:`get_unique_animation_names<class_GLTFState_method_get_unique_animation_names>` **(** **)**                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String[]<class_String>`                 | :ref:`get_unique_names<class_GLTFState_method_get_unique_names>` **(** **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_accessors<class_GLTFState_method_set_accessors>` **(** :ref:`GLTFAccessor[]<class_GLTFAccessor>` accessors **)**                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_animations<class_GLTFState_method_set_animations>` **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)**                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_buffer_views<class_GLTFState_method_set_buffer_views>` **(** :ref:`GLTFBufferView[]<class_GLTFBufferView>` buffer_views **)**               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_cameras<class_GLTFState_method_set_cameras>` **(** :ref:`GLTFCamera[]<class_GLTFCamera>` cameras **)**                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_images<class_GLTFState_method_set_images>` **(** :ref:`Texture2D[]<class_Texture2D>` images **)**                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_lights<class_GLTFState_method_set_lights>` **(** :ref:`GLTFLight[]<class_GLTFLight>` lights **)**                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_materials<class_GLTFState_method_set_materials>` **(** :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` materials **)**                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_meshes<class_GLTFState_method_set_meshes>` **(** :ref:`GLTFMesh[]<class_GLTFMesh>` meshes **)**                                             |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_nodes<class_GLTFState_method_set_nodes>` **(** :ref:`GLTFNode[]<class_GLTFNode>` nodes **)**                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_skeleton_to_node<class_GLTFState_method_set_skeleton_to_node>` **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)**             |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_skeletons<class_GLTFState_method_set_skeletons>` **(** :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` skeletons **)**                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_skins<class_GLTFState_method_set_skins>` **(** :ref:`GLTFSkin[]<class_GLTFSkin>` skins **)**                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_textures<class_GLTFState_method_set_textures>` **(** :ref:`GLTFTexture[]<class_GLTFTexture>` textures **)**                                 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_unique_animation_names<class_GLTFState_method_set_unique_animation_names>` **(** :ref:`String[]<class_String>` unique_animation_names **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_unique_names<class_GLTFState_method_set_unique_names>` **(** :ref:`String[]<class_String>` unique_names **)**                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_GLTFState_property_base_path:

- :ref:`String<class_String>` **base_path**

+-----------+----------------------+
| *Default* | ``""``               |
+-----------+----------------------+
| *Setter*  | set_base_path(value) |
+-----------+----------------------+
| *Getter*  | get_base_path()      |
+-----------+----------------------+

----

.. _class_GLTFState_property_buffers:

- :ref:`PackedByteArray[]<class_PackedByteArray>` **buffers**

+-----------+--------------------+
| *Default* | ``[]``             |
+-----------+--------------------+
| *Setter*  | set_buffers(value) |
+-----------+--------------------+
| *Getter*  | get_buffers()      |
+-----------+--------------------+

----

.. _class_GLTFState_property_create_animations:

- :ref:`bool<class_bool>` **create_animations**

+-----------+------------------------------+
| *Default* | ``true``                     |
+-----------+------------------------------+
| *Setter*  | set_create_animations(value) |
+-----------+------------------------------+
| *Getter*  | get_create_animations()      |
+-----------+------------------------------+

----

.. _class_GLTFState_property_glb_data:

- :ref:`PackedByteArray<class_PackedByteArray>` **glb_data**

+-----------+-----------------------+
| *Default* | ``PackedByteArray()`` |
+-----------+-----------------------+
| *Setter*  | set_glb_data(value)   |
+-----------+-----------------------+
| *Getter*  | get_glb_data()        |
+-----------+-----------------------+

----

.. _class_GLTFState_property_json:

- :ref:`Dictionary<class_Dictionary>` **json**

+-----------+-----------------+
| *Default* | ``{}``          |
+-----------+-----------------+
| *Setter*  | set_json(value) |
+-----------+-----------------+
| *Getter*  | get_json()      |
+-----------+-----------------+

----

.. _class_GLTFState_property_major_version:

- :ref:`int<class_int>` **major_version**

+-----------+--------------------------+
| *Default* | ``0``                    |
+-----------+--------------------------+
| *Setter*  | set_major_version(value) |
+-----------+--------------------------+
| *Getter*  | get_major_version()      |
+-----------+--------------------------+

----

.. _class_GLTFState_property_minor_version:

- :ref:`int<class_int>` **minor_version**

+-----------+--------------------------+
| *Default* | ``0``                    |
+-----------+--------------------------+
| *Setter*  | set_minor_version(value) |
+-----------+--------------------------+
| *Getter*  | get_minor_version()      |
+-----------+--------------------------+

----

.. _class_GLTFState_property_root_nodes:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **root_nodes**

+-----------+------------------------+
| *Default* | ``PackedInt32Array()`` |
+-----------+------------------------+
| *Setter*  | set_root_nodes(value)  |
+-----------+------------------------+
| *Getter*  | get_root_nodes()       |
+-----------+------------------------+

----

.. _class_GLTFState_property_scene_name:

- :ref:`String<class_String>` **scene_name**

+-----------+-----------------------+
| *Default* | ``""``                |
+-----------+-----------------------+
| *Setter*  | set_scene_name(value) |
+-----------+-----------------------+
| *Getter*  | get_scene_name()      |
+-----------+-----------------------+

----

.. _class_GLTFState_property_use_named_skin_binds:

- :ref:`bool<class_bool>` **use_named_skin_binds**

+-----------+---------------------------------+
| *Default* | ``false``                       |
+-----------+---------------------------------+
| *Setter*  | set_use_named_skin_binds(value) |
+-----------+---------------------------------+
| *Getter*  | get_use_named_skin_binds()      |
+-----------+---------------------------------+

Method Descriptions
-------------------

.. _class_GLTFState_method_get_accessors:

- :ref:`GLTFAccessor[]<class_GLTFAccessor>` **get_accessors** **(** **)**

----

.. _class_GLTFState_method_get_animation_player:

- :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player** **(** :ref:`int<class_int>` idx **)**

----

.. _class_GLTFState_method_get_animation_players_count:

- :ref:`int<class_int>` **get_animation_players_count** **(** :ref:`int<class_int>` idx **)**

----

.. _class_GLTFState_method_get_animations:

- :ref:`GLTFAnimation[]<class_GLTFAnimation>` **get_animations** **(** **)**

----

.. _class_GLTFState_method_get_buffer_views:

- :ref:`GLTFBufferView[]<class_GLTFBufferView>` **get_buffer_views** **(** **)**

----

.. _class_GLTFState_method_get_cameras:

- :ref:`GLTFCamera[]<class_GLTFCamera>` **get_cameras** **(** **)**

----

.. _class_GLTFState_method_get_images:

- :ref:`Texture2D[]<class_Texture2D>` **get_images** **(** **)**

----

.. _class_GLTFState_method_get_lights:

- :ref:`GLTFLight[]<class_GLTFLight>` **get_lights** **(** **)**

----

.. _class_GLTFState_method_get_materials:

- :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` **get_materials** **(** **)**

----

.. _class_GLTFState_method_get_meshes:

- :ref:`GLTFMesh[]<class_GLTFMesh>` **get_meshes** **(** **)**

----

.. _class_GLTFState_method_get_nodes:

- :ref:`GLTFNode[]<class_GLTFNode>` **get_nodes** **(** **)**

----

.. _class_GLTFState_method_get_scene_node:

- :ref:`Node<class_Node>` **get_scene_node** **(** :ref:`int<class_int>` idx **)**

----

.. _class_GLTFState_method_get_skeleton_to_node:

- :ref:`Dictionary<class_Dictionary>` **get_skeleton_to_node** **(** **)**

----

.. _class_GLTFState_method_get_skeletons:

- :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` **get_skeletons** **(** **)**

----

.. _class_GLTFState_method_get_skins:

- :ref:`GLTFSkin[]<class_GLTFSkin>` **get_skins** **(** **)**

----

.. _class_GLTFState_method_get_textures:

- :ref:`GLTFTexture[]<class_GLTFTexture>` **get_textures** **(** **)**

----

.. _class_GLTFState_method_get_unique_animation_names:

- :ref:`String[]<class_String>` **get_unique_animation_names** **(** **)**

----

.. _class_GLTFState_method_get_unique_names:

- :ref:`String[]<class_String>` **get_unique_names** **(** **)**

----

.. _class_GLTFState_method_set_accessors:

- void **set_accessors** **(** :ref:`GLTFAccessor[]<class_GLTFAccessor>` accessors **)**

----

.. _class_GLTFState_method_set_animations:

- void **set_animations** **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)**

----

.. _class_GLTFState_method_set_buffer_views:

- void **set_buffer_views** **(** :ref:`GLTFBufferView[]<class_GLTFBufferView>` buffer_views **)**

----

.. _class_GLTFState_method_set_cameras:

- void **set_cameras** **(** :ref:`GLTFCamera[]<class_GLTFCamera>` cameras **)**

----

.. _class_GLTFState_method_set_images:

- void **set_images** **(** :ref:`Texture2D[]<class_Texture2D>` images **)**

----

.. _class_GLTFState_method_set_lights:

- void **set_lights** **(** :ref:`GLTFLight[]<class_GLTFLight>` lights **)**

----

.. _class_GLTFState_method_set_materials:

- void **set_materials** **(** :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` materials **)**

----

.. _class_GLTFState_method_set_meshes:

- void **set_meshes** **(** :ref:`GLTFMesh[]<class_GLTFMesh>` meshes **)**

----

.. _class_GLTFState_method_set_nodes:

- void **set_nodes** **(** :ref:`GLTFNode[]<class_GLTFNode>` nodes **)**

----

.. _class_GLTFState_method_set_skeleton_to_node:

- void **set_skeleton_to_node** **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)**

----

.. _class_GLTFState_method_set_skeletons:

- void **set_skeletons** **(** :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` skeletons **)**

----

.. _class_GLTFState_method_set_skins:

- void **set_skins** **(** :ref:`GLTFSkin[]<class_GLTFSkin>` skins **)**

----

.. _class_GLTFState_method_set_textures:

- void **set_textures** **(** :ref:`GLTFTexture[]<class_GLTFTexture>` textures **)**

----

.. _class_GLTFState_method_set_unique_animation_names:

- void **set_unique_animation_names** **(** :ref:`String[]<class_String>` unique_animation_names **)**

----

.. _class_GLTFState_method_set_unique_names:

- void **set_unique_names** **(** :ref:`String[]<class_String>` 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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`