mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with current master branch (fc1c25d29)
This commit is contained in:
Rémi Verschelde
+97
-73
@@ -42,79 +42,83 @@ Properties
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_used_extension<class_GLTFState_method_add_used_extension>` **(** :ref:`String<class_String>` extension_name, :ref:`bool<class_bool>` required **)** |
|
||||
+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`GLTFTextureSampler[]<class_GLTFTextureSampler>` | :ref:`get_texture_samplers<class_GLTFState_method_get_texture_samplers>` **(** **)** |
|
||||
+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_texture_samplers<class_GLTFState_method_set_texture_samplers>` **(** :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` texture_samplers **)** |
|
||||
+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_used_extension<class_GLTFState_method_add_used_extension>` **(** :ref:`String<class_String>` extension_name, :ref:`bool<class_bool>` required **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`GLTFAccessor[]<class_GLTFAccessor>` | :ref:`get_accessors<class_GLTFState_method_get_accessors>` **(** **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`get_additional_data<class_GLTFState_method_get_additional_data>` **(** :ref:`StringName<class_StringName>` extension_name **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`GLTFTextureSampler[]<class_GLTFTextureSampler>` | :ref:`get_texture_samplers<class_GLTFState_method_get_texture_samplers>` **(** **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_additional_data<class_GLTFState_method_set_additional_data>` **(** :ref:`StringName<class_StringName>` extension_name, :ref:`Variant<class_Variant>` additional_data **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_texture_samplers<class_GLTFState_method_set_texture_samplers>` **(** :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` texture_samplers **)** |
|
||||
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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
|
||||
---------------------
|
||||
@@ -274,6 +278,16 @@ Appends an extension to the list of extensions used by this GLTF file during ser
|
||||
|
||||
----
|
||||
|
||||
.. _class_GLTFState_method_get_additional_data:
|
||||
|
||||
- :ref:`Variant<class_Variant>` **get_additional_data** **(** :ref:`StringName<class_StringName>` extension_name **)**
|
||||
|
||||
Gets additional arbitrary data in this ``GLTFState`` instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` classes, which is important because they are stateless.
|
||||
|
||||
The argument should be the :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null.
|
||||
|
||||
----
|
||||
|
||||
.. _class_GLTFState_method_get_animation_player:
|
||||
|
||||
- :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player** **(** :ref:`int<class_int>` idx **)**
|
||||
@@ -390,6 +404,16 @@ Retrieves the array of texture samplers that are used by the textures contained
|
||||
|
||||
----
|
||||
|
||||
.. _class_GLTFState_method_set_additional_data:
|
||||
|
||||
- void **set_additional_data** **(** :ref:`StringName<class_StringName>` extension_name, :ref:`Variant<class_Variant>` additional_data **)**
|
||||
|
||||
Sets additional arbitrary data in this ``GLTFState`` instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` classes, which is important because they are stateless.
|
||||
|
||||
The first argument should be the :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.
|
||||
|
||||
----
|
||||
|
||||
.. _class_GLTFState_method_set_animations:
|
||||
|
||||
- void **set_animations** **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)**
|
||||
|
||||
Reference in New Issue
Block a user