123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the GLTFState.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_GLTFState:
- GLTFState
- =========
- **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 ``GLTFState`` within a script will cause an error in an exported project.
- Properties
- ----------
- +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
- | :ref:`Array<class_Array>` | :ref:`buffers<class_GLTFState_property_buffers>` | ``[ ]`` |
- +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
- | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`glb_data<class_GLTFState_property_glb_data>` | ``PoolByteArray( )`` |
- +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
- | :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:`Array<class_Array>` | :ref:`root_nodes<class_GLTFState_property_root_nodes>` | ``[ ]`` |
- +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
- | :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:`Array<class_Array>` | :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:`Array<class_Array>` | :ref:`get_animations<class_GLTFState_method_get_animations>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_buffer_views<class_GLTFState_method_get_buffer_views>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_cameras<class_GLTFState_method_get_cameras>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_images<class_GLTFState_method_get_images>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_lights<class_GLTFState_method_get_lights>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_materials<class_GLTFState_method_get_materials>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_meshes<class_GLTFState_method_get_meshes>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :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:`Array<class_Array>` | :ref:`get_skeletons<class_GLTFState_method_get_skeletons>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_skins<class_GLTFState_method_get_skins>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_textures<class_GLTFState_method_get_textures>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_unique_animation_names<class_GLTFState_method_get_unique_animation_names>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_unique_names<class_GLTFState_method_get_unique_names>` **(** **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_accessors<class_GLTFState_method_set_accessors>` **(** :ref:`Array<class_Array>` accessors **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_animations<class_GLTFState_method_set_animations>` **(** :ref:`Array<class_Array>` animations **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_buffer_views<class_GLTFState_method_set_buffer_views>` **(** :ref:`Array<class_Array>` buffer_views **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_cameras<class_GLTFState_method_set_cameras>` **(** :ref:`Array<class_Array>` cameras **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_images<class_GLTFState_method_set_images>` **(** :ref:`Array<class_Array>` images **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_lights<class_GLTFState_method_set_lights>` **(** :ref:`Array<class_Array>` lights **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_materials<class_GLTFState_method_set_materials>` **(** :ref:`Array<class_Array>` materials **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_meshes<class_GLTFState_method_set_meshes>` **(** :ref:`Array<class_Array>` meshes **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_nodes<class_GLTFState_method_set_nodes>` **(** :ref:`Array<class_Array>` 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:`Array<class_Array>` skeletons **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_skins<class_GLTFState_method_set_skins>` **(** :ref:`Array<class_Array>` skins **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_textures<class_GLTFState_method_set_textures>` **(** :ref:`Array<class_Array>` textures **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_unique_animation_names<class_GLTFState_method_set_unique_animation_names>` **(** :ref:`Array<class_Array>` unique_animation_names **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_unique_names<class_GLTFState_method_set_unique_names>` **(** :ref:`Array<class_Array>` unique_names **)** |
- +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_GLTFState_property_buffers:
- - :ref:`Array<class_Array>` **buffers**
- +-----------+--------------------+
- | *Default* | ``[ ]`` |
- +-----------+--------------------+
- | *Setter* | set_buffers(value) |
- +-----------+--------------------+
- | *Getter* | get_buffers() |
- +-----------+--------------------+
- ----
- .. _class_GLTFState_property_glb_data:
- - :ref:`PoolByteArray<class_PoolByteArray>` **glb_data**
- +-----------+-----------------------+
- | *Default* | ``PoolByteArray( )`` |
- +-----------+-----------------------+
- | *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:`Array<class_Array>` **root_nodes**
- +-----------+-----------------------+
- | *Default* | ``[ ]`` |
- +-----------+-----------------------+
- | *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:`Array<class_Array>` **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:`Array<class_Array>` **get_animations** **(** **)**
- ----
- .. _class_GLTFState_method_get_buffer_views:
- - :ref:`Array<class_Array>` **get_buffer_views** **(** **)**
- ----
- .. _class_GLTFState_method_get_cameras:
- - :ref:`Array<class_Array>` **get_cameras** **(** **)**
- ----
- .. _class_GLTFState_method_get_images:
- - :ref:`Array<class_Array>` **get_images** **(** **)**
- ----
- .. _class_GLTFState_method_get_lights:
- - :ref:`Array<class_Array>` **get_lights** **(** **)**
- ----
- .. _class_GLTFState_method_get_materials:
- - :ref:`Array<class_Array>` **get_materials** **(** **)**
- ----
- .. _class_GLTFState_method_get_meshes:
- - :ref:`Array<class_Array>` **get_meshes** **(** **)**
- ----
- .. _class_GLTFState_method_get_nodes:
- - :ref:`Array<class_Array>` **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:`Array<class_Array>` **get_skeletons** **(** **)**
- ----
- .. _class_GLTFState_method_get_skins:
- - :ref:`Array<class_Array>` **get_skins** **(** **)**
- ----
- .. _class_GLTFState_method_get_textures:
- - :ref:`Array<class_Array>` **get_textures** **(** **)**
- ----
- .. _class_GLTFState_method_get_unique_animation_names:
- - :ref:`Array<class_Array>` **get_unique_animation_names** **(** **)**
- ----
- .. _class_GLTFState_method_get_unique_names:
- - :ref:`Array<class_Array>` **get_unique_names** **(** **)**
- ----
- .. _class_GLTFState_method_set_accessors:
- - void **set_accessors** **(** :ref:`Array<class_Array>` accessors **)**
- ----
- .. _class_GLTFState_method_set_animations:
- - void **set_animations** **(** :ref:`Array<class_Array>` animations **)**
- ----
- .. _class_GLTFState_method_set_buffer_views:
- - void **set_buffer_views** **(** :ref:`Array<class_Array>` buffer_views **)**
- ----
- .. _class_GLTFState_method_set_cameras:
- - void **set_cameras** **(** :ref:`Array<class_Array>` cameras **)**
- ----
- .. _class_GLTFState_method_set_images:
- - void **set_images** **(** :ref:`Array<class_Array>` images **)**
- ----
- .. _class_GLTFState_method_set_lights:
- - void **set_lights** **(** :ref:`Array<class_Array>` lights **)**
- ----
- .. _class_GLTFState_method_set_materials:
- - void **set_materials** **(** :ref:`Array<class_Array>` materials **)**
- ----
- .. _class_GLTFState_method_set_meshes:
- - void **set_meshes** **(** :ref:`Array<class_Array>` meshes **)**
- ----
- .. _class_GLTFState_method_set_nodes:
- - void **set_nodes** **(** :ref:`Array<class_Array>` 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:`Array<class_Array>` skeletons **)**
- ----
- .. _class_GLTFState_method_set_skins:
- - void **set_skins** **(** :ref:`Array<class_Array>` skins **)**
- ----
- .. _class_GLTFState_method_set_textures:
- - void **set_textures** **(** :ref:`Array<class_Array>` textures **)**
- ----
- .. _class_GLTFState_method_set_unique_animation_names:
- - void **set_unique_animation_names** **(** :ref:`Array<class_Array>` unique_animation_names **)**
- ----
- .. _class_GLTFState_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.)`
|