class_gltfstate.rst 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.3/modules/gltf/doc_classes/GLTFState.xml.
  6. .. _class_GLTFState:
  7. GLTFState
  8. =========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`FBXState<class_FBXState>`
  11. Represents all data of a GLTF file.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Contains all nodes and resources of a GLTF file. This is used by :ref:`GLTFDocument<class_GLTFDocument>` as data storage, which allows :ref:`GLTFDocument<class_GLTFDocument>` and all :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` classes to remain stateless.
  16. GLTFState can be populated by :ref:`GLTFDocument<class_GLTFDocument>` reading a file or by converting a Godot scene. Then the data can either be used to create a Godot scene or save to a GLTF file. The code that converts to/from a Godot scene can be intercepted at arbitrary points by :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` classes. This allows for custom data to be stored in the GLTF file or for custom data to be converted to/from Godot nodes.
  17. .. rst-class:: classref-introduction-group
  18. Tutorials
  19. ---------
  20. - :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>`
  21. - `GLTF asset header schema <https://github.com/KhronosGroup/glTF/blob/main/specification/2.0/schema/asset.schema.json">`__
  22. .. rst-class:: classref-reftable-group
  23. Properties
  24. ----------
  25. .. table::
  26. :widths: auto
  27. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  28. | :ref:`float<class_float>` | :ref:`bake_fps<class_GLTFState_property_bake_fps>` | ``30.0`` |
  29. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  30. | :ref:`String<class_String>` | :ref:`base_path<class_GLTFState_property_base_path>` | ``""`` |
  31. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  32. | :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\] | :ref:`buffers<class_GLTFState_property_buffers>` | ``[]`` |
  33. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  34. | :ref:`String<class_String>` | :ref:`copyright<class_GLTFState_property_copyright>` | ``""`` |
  35. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`create_animations<class_GLTFState_property_create_animations>` | ``true`` |
  37. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  38. | :ref:`String<class_String>` | :ref:`filename<class_GLTFState_property_filename>` | ``""`` |
  39. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  40. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`glb_data<class_GLTFState_property_glb_data>` | ``PackedByteArray()`` |
  41. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  42. | :ref:`bool<class_bool>` | :ref:`import_as_skeleton_bones<class_GLTFState_property_import_as_skeleton_bones>` | ``false`` |
  43. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  44. | :ref:`Dictionary<class_Dictionary>` | :ref:`json<class_GLTFState_property_json>` | ``{}`` |
  45. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  46. | :ref:`int<class_int>` | :ref:`major_version<class_GLTFState_property_major_version>` | ``0`` |
  47. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  48. | :ref:`int<class_int>` | :ref:`minor_version<class_GLTFState_property_minor_version>` | ``0`` |
  49. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  50. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`root_nodes<class_GLTFState_property_root_nodes>` | ``PackedInt32Array()`` |
  51. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  52. | :ref:`String<class_String>` | :ref:`scene_name<class_GLTFState_property_scene_name>` | ``""`` |
  53. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`use_named_skin_binds<class_GLTFState_property_use_named_skin_binds>` | ``false`` |
  55. +----------------------------------------------------------------------------+------------------------------------------------------------------------------------+------------------------+
  56. .. rst-class:: classref-reftable-group
  57. Methods
  58. -------
  59. .. table::
  60. :widths: auto
  61. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | |void| | :ref:`add_used_extension<class_GLTFState_method_add_used_extension>`\ (\ extension_name\: :ref:`String<class_String>`, required\: :ref:`bool<class_bool>`\ ) |
  63. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`int<class_int>` | :ref:`append_data_to_buffers<class_GLTFState_method_append_data_to_buffers>`\ (\ data\: :ref:`PackedByteArray<class_PackedByteArray>`, deduplication\: :ref:`bool<class_bool>`\ ) |
  65. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Array<class_Array>`\[:ref:`GLTFAccessor<class_GLTFAccessor>`\] | :ref:`get_accessors<class_GLTFState_method_get_accessors>`\ (\ ) |
  67. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`Variant<class_Variant>` | :ref:`get_additional_data<class_GLTFState_method_get_additional_data>`\ (\ extension_name\: :ref:`StringName<class_StringName>`\ ) |
  69. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`AnimationPlayer<class_AnimationPlayer>` | :ref:`get_animation_player<class_GLTFState_method_get_animation_player>`\ (\ idx\: :ref:`int<class_int>`\ ) |
  71. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`get_animation_players_count<class_GLTFState_method_get_animation_players_count>`\ (\ idx\: :ref:`int<class_int>`\ ) |
  73. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`Array<class_Array>`\[:ref:`GLTFAnimation<class_GLTFAnimation>`\] | :ref:`get_animations<class_GLTFState_method_get_animations>`\ (\ ) |
  75. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`Array<class_Array>`\[:ref:`GLTFBufferView<class_GLTFBufferView>`\] | :ref:`get_buffer_views<class_GLTFState_method_get_buffer_views>`\ (\ ) |
  77. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Array<class_Array>`\[:ref:`GLTFCamera<class_GLTFCamera>`\] | :ref:`get_cameras<class_GLTFState_method_get_cameras>`\ (\ ) |
  79. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`int<class_int>` | :ref:`get_handle_binary_image<class_GLTFState_method_get_handle_binary_image>`\ (\ ) |
  81. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] | :ref:`get_images<class_GLTFState_method_get_images>`\ (\ ) |
  83. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`Array<class_Array>`\[:ref:`GLTFLight<class_GLTFLight>`\] | :ref:`get_lights<class_GLTFState_method_get_lights>`\ (\ ) |
  85. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Array<class_Array>`\[:ref:`Material<class_Material>`\] | :ref:`get_materials<class_GLTFState_method_get_materials>`\ (\ ) |
  87. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`Array<class_Array>`\[:ref:`GLTFMesh<class_GLTFMesh>`\] | :ref:`get_meshes<class_GLTFState_method_get_meshes>`\ (\ ) |
  89. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`int<class_int>` | :ref:`get_node_index<class_GLTFState_method_get_node_index>`\ (\ scene_node\: :ref:`Node<class_Node>`\ ) |
  91. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`Array<class_Array>`\[:ref:`GLTFNode<class_GLTFNode>`\] | :ref:`get_nodes<class_GLTFState_method_get_nodes>`\ (\ ) |
  93. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Node<class_Node>` | :ref:`get_scene_node<class_GLTFState_method_get_scene_node>`\ (\ idx\: :ref:`int<class_int>`\ ) |
  95. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`Array<class_Array>`\[:ref:`GLTFSkeleton<class_GLTFSkeleton>`\] | :ref:`get_skeletons<class_GLTFState_method_get_skeletons>`\ (\ ) |
  97. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`Array<class_Array>`\[:ref:`GLTFSkin<class_GLTFSkin>`\] | :ref:`get_skins<class_GLTFState_method_get_skins>`\ (\ ) |
  99. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`Array<class_Array>`\[:ref:`GLTFTextureSampler<class_GLTFTextureSampler>`\] | :ref:`get_texture_samplers<class_GLTFState_method_get_texture_samplers>`\ (\ ) |
  101. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`Array<class_Array>`\[:ref:`GLTFTexture<class_GLTFTexture>`\] | :ref:`get_textures<class_GLTFState_method_get_textures>`\ (\ ) |
  103. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`get_unique_animation_names<class_GLTFState_method_get_unique_animation_names>`\ (\ ) |
  105. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`get_unique_names<class_GLTFState_method_get_unique_names>`\ (\ ) |
  107. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`set_accessors<class_GLTFState_method_set_accessors>`\ (\ accessors\: :ref:`Array<class_Array>`\[:ref:`GLTFAccessor<class_GLTFAccessor>`\]\ ) |
  109. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`set_additional_data<class_GLTFState_method_set_additional_data>`\ (\ extension_name\: :ref:`StringName<class_StringName>`, additional_data\: :ref:`Variant<class_Variant>`\ ) |
  111. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`set_animations<class_GLTFState_method_set_animations>`\ (\ animations\: :ref:`Array<class_Array>`\[:ref:`GLTFAnimation<class_GLTFAnimation>`\]\ ) |
  113. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | |void| | :ref:`set_buffer_views<class_GLTFState_method_set_buffer_views>`\ (\ buffer_views\: :ref:`Array<class_Array>`\[:ref:`GLTFBufferView<class_GLTFBufferView>`\]\ ) |
  115. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | |void| | :ref:`set_cameras<class_GLTFState_method_set_cameras>`\ (\ cameras\: :ref:`Array<class_Array>`\[:ref:`GLTFCamera<class_GLTFCamera>`\]\ ) |
  117. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | |void| | :ref:`set_handle_binary_image<class_GLTFState_method_set_handle_binary_image>`\ (\ method\: :ref:`int<class_int>`\ ) |
  119. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | |void| | :ref:`set_images<class_GLTFState_method_set_images>`\ (\ images\: :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\]\ ) |
  121. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | |void| | :ref:`set_lights<class_GLTFState_method_set_lights>`\ (\ lights\: :ref:`Array<class_Array>`\[:ref:`GLTFLight<class_GLTFLight>`\]\ ) |
  123. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | |void| | :ref:`set_materials<class_GLTFState_method_set_materials>`\ (\ materials\: :ref:`Array<class_Array>`\[:ref:`Material<class_Material>`\]\ ) |
  125. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | |void| | :ref:`set_meshes<class_GLTFState_method_set_meshes>`\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`GLTFMesh<class_GLTFMesh>`\]\ ) |
  127. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | |void| | :ref:`set_nodes<class_GLTFState_method_set_nodes>`\ (\ nodes\: :ref:`Array<class_Array>`\[:ref:`GLTFNode<class_GLTFNode>`\]\ ) |
  129. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | |void| | :ref:`set_skeletons<class_GLTFState_method_set_skeletons>`\ (\ skeletons\: :ref:`Array<class_Array>`\[:ref:`GLTFSkeleton<class_GLTFSkeleton>`\]\ ) |
  131. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | |void| | :ref:`set_skins<class_GLTFState_method_set_skins>`\ (\ skins\: :ref:`Array<class_Array>`\[:ref:`GLTFSkin<class_GLTFSkin>`\]\ ) |
  133. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | |void| | :ref:`set_texture_samplers<class_GLTFState_method_set_texture_samplers>`\ (\ texture_samplers\: :ref:`Array<class_Array>`\[:ref:`GLTFTextureSampler<class_GLTFTextureSampler>`\]\ ) |
  135. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | |void| | :ref:`set_textures<class_GLTFState_method_set_textures>`\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`GLTFTexture<class_GLTFTexture>`\]\ ) |
  137. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | |void| | :ref:`set_unique_animation_names<class_GLTFState_method_set_unique_animation_names>`\ (\ unique_animation_names\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ ) |
  139. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | |void| | :ref:`set_unique_names<class_GLTFState_method_set_unique_names>`\ (\ unique_names\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ ) |
  141. +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. .. rst-class:: classref-section-separator
  143. ----
  144. .. rst-class:: classref-descriptions-group
  145. Constants
  146. ---------
  147. .. _class_GLTFState_constant_HANDLE_BINARY_DISCARD_TEXTURES:
  148. .. rst-class:: classref-constant
  149. **HANDLE_BINARY_DISCARD_TEXTURES** = ``0`` :ref:`๐Ÿ”—<class_GLTFState_constant_HANDLE_BINARY_DISCARD_TEXTURES>`
  150. Discards all embedded textures and uses untextured materials.
  151. .. _class_GLTFState_constant_HANDLE_BINARY_EXTRACT_TEXTURES:
  152. .. rst-class:: classref-constant
  153. **HANDLE_BINARY_EXTRACT_TEXTURES** = ``1`` :ref:`๐Ÿ”—<class_GLTFState_constant_HANDLE_BINARY_EXTRACT_TEXTURES>`
  154. Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime.
  155. .. _class_GLTFState_constant_HANDLE_BINARY_EMBED_AS_BASISU:
  156. .. rst-class:: classref-constant
  157. **HANDLE_BINARY_EMBED_AS_BASISU** = ``2`` :ref:`๐Ÿ”—<class_GLTFState_constant_HANDLE_BINARY_EMBED_AS_BASISU>`
  158. Embeds textures VRAM compressed with Basis Universal into the generated scene.
  159. .. _class_GLTFState_constant_HANDLE_BINARY_EMBED_AS_UNCOMPRESSED:
  160. .. rst-class:: classref-constant
  161. **HANDLE_BINARY_EMBED_AS_UNCOMPRESSED** = ``3`` :ref:`๐Ÿ”—<class_GLTFState_constant_HANDLE_BINARY_EMBED_AS_UNCOMPRESSED>`
  162. Embeds textures compressed losslessly into the generated scene, matching old behavior.
  163. .. rst-class:: classref-section-separator
  164. ----
  165. .. rst-class:: classref-descriptions-group
  166. Property Descriptions
  167. ---------------------
  168. .. _class_GLTFState_property_bake_fps:
  169. .. rst-class:: classref-property
  170. :ref:`float<class_float>` **bake_fps** = ``30.0`` :ref:`๐Ÿ”—<class_GLTFState_property_bake_fps>`
  171. .. rst-class:: classref-property-setget
  172. - |void| **set_bake_fps**\ (\ value\: :ref:`float<class_float>`\ )
  173. - :ref:`float<class_float>` **get_bake_fps**\ (\ )
  174. The baking fps of the animation for either import or export.
  175. .. rst-class:: classref-item-separator
  176. ----
  177. .. _class_GLTFState_property_base_path:
  178. .. rst-class:: classref-property
  179. :ref:`String<class_String>` **base_path** = ``""`` :ref:`๐Ÿ”—<class_GLTFState_property_base_path>`
  180. .. rst-class:: classref-property-setget
  181. - |void| **set_base_path**\ (\ value\: :ref:`String<class_String>`\ )
  182. - :ref:`String<class_String>` **get_base_path**\ (\ )
  183. The folder path associated with this GLTF data. This is used to find other files the GLTF file references, like images or binary buffers. This will be set during import when appending from a file, and will be set during export when writing to a file.
  184. .. rst-class:: classref-item-separator
  185. ----
  186. .. _class_GLTFState_property_buffers:
  187. .. rst-class:: classref-property
  188. :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\] **buffers** = ``[]`` :ref:`๐Ÿ”—<class_GLTFState_property_buffers>`
  189. .. rst-class:: classref-property-setget
  190. - |void| **set_buffers**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\]\ )
  191. - :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\] **get_buffers**\ (\ )
  192. .. container:: contribute
  193. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  194. .. rst-class:: classref-item-separator
  195. ----
  196. .. _class_GLTFState_property_copyright:
  197. .. rst-class:: classref-property
  198. :ref:`String<class_String>` **copyright** = ``""`` :ref:`๐Ÿ”—<class_GLTFState_property_copyright>`
  199. .. rst-class:: classref-property-setget
  200. - |void| **set_copyright**\ (\ value\: :ref:`String<class_String>`\ )
  201. - :ref:`String<class_String>` **get_copyright**\ (\ )
  202. The copyright string in the asset header of the GLTF file. This is set during import if present and export if non-empty. See the GLTF asset header documentation for more information.
  203. .. rst-class:: classref-item-separator
  204. ----
  205. .. _class_GLTFState_property_create_animations:
  206. .. rst-class:: classref-property
  207. :ref:`bool<class_bool>` **create_animations** = ``true`` :ref:`๐Ÿ”—<class_GLTFState_property_create_animations>`
  208. .. rst-class:: classref-property-setget
  209. - |void| **set_create_animations**\ (\ value\: :ref:`bool<class_bool>`\ )
  210. - :ref:`bool<class_bool>` **get_create_animations**\ (\ )
  211. .. container:: contribute
  212. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  213. .. rst-class:: classref-item-separator
  214. ----
  215. .. _class_GLTFState_property_filename:
  216. .. rst-class:: classref-property
  217. :ref:`String<class_String>` **filename** = ``""`` :ref:`๐Ÿ”—<class_GLTFState_property_filename>`
  218. .. rst-class:: classref-property-setget
  219. - |void| **set_filename**\ (\ value\: :ref:`String<class_String>`\ )
  220. - :ref:`String<class_String>` **get_filename**\ (\ )
  221. The file name associated with this GLTF data. If it ends with ``.gltf``, this is text-based GLTF, otherwise this is binary GLB. This will be set during import when appending from a file, and will be set during export when writing to a file. If writing to a buffer, this will be an empty string.
  222. .. rst-class:: classref-item-separator
  223. ----
  224. .. _class_GLTFState_property_glb_data:
  225. .. rst-class:: classref-property
  226. :ref:`PackedByteArray<class_PackedByteArray>` **glb_data** = ``PackedByteArray()`` :ref:`๐Ÿ”—<class_GLTFState_property_glb_data>`
  227. .. rst-class:: classref-property-setget
  228. - |void| **set_glb_data**\ (\ value\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
  229. - :ref:`PackedByteArray<class_PackedByteArray>` **get_glb_data**\ (\ )
  230. The binary buffer attached to a .glb file.
  231. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedByteArray<class_PackedByteArray>` for more details.
  232. .. rst-class:: classref-item-separator
  233. ----
  234. .. _class_GLTFState_property_import_as_skeleton_bones:
  235. .. rst-class:: classref-property
  236. :ref:`bool<class_bool>` **import_as_skeleton_bones** = ``false`` :ref:`๐Ÿ”—<class_GLTFState_property_import_as_skeleton_bones>`
  237. .. rst-class:: classref-property-setget
  238. - |void| **set_import_as_skeleton_bones**\ (\ value\: :ref:`bool<class_bool>`\ )
  239. - :ref:`bool<class_bool>` **get_import_as_skeleton_bones**\ (\ )
  240. True to force all GLTFNodes in the document to be bones of a single Skeleton3D godot node.
  241. .. rst-class:: classref-item-separator
  242. ----
  243. .. _class_GLTFState_property_json:
  244. .. rst-class:: classref-property
  245. :ref:`Dictionary<class_Dictionary>` **json** = ``{}`` :ref:`๐Ÿ”—<class_GLTFState_property_json>`
  246. .. rst-class:: classref-property-setget
  247. - |void| **set_json**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
  248. - :ref:`Dictionary<class_Dictionary>` **get_json**\ (\ )
  249. The original raw JSON document corresponding to this GLTFState.
  250. .. rst-class:: classref-item-separator
  251. ----
  252. .. _class_GLTFState_property_major_version:
  253. .. rst-class:: classref-property
  254. :ref:`int<class_int>` **major_version** = ``0`` :ref:`๐Ÿ”—<class_GLTFState_property_major_version>`
  255. .. rst-class:: classref-property-setget
  256. - |void| **set_major_version**\ (\ value\: :ref:`int<class_int>`\ )
  257. - :ref:`int<class_int>` **get_major_version**\ (\ )
  258. .. container:: contribute
  259. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  260. .. rst-class:: classref-item-separator
  261. ----
  262. .. _class_GLTFState_property_minor_version:
  263. .. rst-class:: classref-property
  264. :ref:`int<class_int>` **minor_version** = ``0`` :ref:`๐Ÿ”—<class_GLTFState_property_minor_version>`
  265. .. rst-class:: classref-property-setget
  266. - |void| **set_minor_version**\ (\ value\: :ref:`int<class_int>`\ )
  267. - :ref:`int<class_int>` **get_minor_version**\ (\ )
  268. .. container:: contribute
  269. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  270. .. rst-class:: classref-item-separator
  271. ----
  272. .. _class_GLTFState_property_root_nodes:
  273. .. rst-class:: classref-property
  274. :ref:`PackedInt32Array<class_PackedInt32Array>` **root_nodes** = ``PackedInt32Array()`` :ref:`๐Ÿ”—<class_GLTFState_property_root_nodes>`
  275. .. rst-class:: classref-property-setget
  276. - |void| **set_root_nodes**\ (\ value\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ )
  277. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_root_nodes**\ (\ )
  278. The root nodes of the GLTF file. Typically, a GLTF file will only have one scene, and therefore one root node. However, a GLTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Godot scene.
  279. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array<class_PackedInt32Array>` for more details.
  280. .. rst-class:: classref-item-separator
  281. ----
  282. .. _class_GLTFState_property_scene_name:
  283. .. rst-class:: classref-property
  284. :ref:`String<class_String>` **scene_name** = ``""`` :ref:`๐Ÿ”—<class_GLTFState_property_scene_name>`
  285. .. rst-class:: classref-property-setget
  286. - |void| **set_scene_name**\ (\ value\: :ref:`String<class_String>`\ )
  287. - :ref:`String<class_String>` **get_scene_name**\ (\ )
  288. The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the GLTF file.
  289. .. rst-class:: classref-item-separator
  290. ----
  291. .. _class_GLTFState_property_use_named_skin_binds:
  292. .. rst-class:: classref-property
  293. :ref:`bool<class_bool>` **use_named_skin_binds** = ``false`` :ref:`๐Ÿ”—<class_GLTFState_property_use_named_skin_binds>`
  294. .. rst-class:: classref-property-setget
  295. - |void| **set_use_named_skin_binds**\ (\ value\: :ref:`bool<class_bool>`\ )
  296. - :ref:`bool<class_bool>` **get_use_named_skin_binds**\ (\ )
  297. .. container:: contribute
  298. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  299. .. rst-class:: classref-section-separator
  300. ----
  301. .. rst-class:: classref-descriptions-group
  302. Method Descriptions
  303. -------------------
  304. .. _class_GLTFState_method_add_used_extension:
  305. .. rst-class:: classref-method
  306. |void| **add_used_extension**\ (\ extension_name\: :ref:`String<class_String>`, required\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_add_used_extension>`
  307. Appends an extension to the list of extensions used by this GLTF file during serialization. If ``required`` is true, the extension will also be added to the list of required extensions. Do not run this in :ref:`GLTFDocumentExtension._export_post<class_GLTFDocumentExtension_private_method__export_post>`, as that stage is too late to add extensions. The final list is sorted alphabetically.
  308. .. rst-class:: classref-item-separator
  309. ----
  310. .. _class_GLTFState_method_append_data_to_buffers:
  311. .. rst-class:: classref-method
  312. :ref:`int<class_int>` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray<class_PackedByteArray>`, deduplication\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_append_data_to_buffers>`
  313. Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferView<class_GLTFBufferView>` for it. The index of the destination :ref:`GLTFBufferView<class_GLTFBufferView>` is returned. If ``deduplication`` is true, the buffers will first be searched for duplicate data, otherwise new bytes will always be appended.
  314. .. rst-class:: classref-item-separator
  315. ----
  316. .. _class_GLTFState_method_get_accessors:
  317. .. rst-class:: classref-method
  318. :ref:`Array<class_Array>`\[:ref:`GLTFAccessor<class_GLTFAccessor>`\] **get_accessors**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_accessors>`
  319. .. container:: contribute
  320. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  321. .. rst-class:: classref-item-separator
  322. ----
  323. .. _class_GLTFState_method_get_additional_data:
  324. .. rst-class:: classref-method
  325. :ref:`Variant<class_Variant>` **get_additional_data**\ (\ extension_name\: :ref:`StringName<class_StringName>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_additional_data>`
  326. 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.
  327. 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.
  328. .. rst-class:: classref-item-separator
  329. ----
  330. .. _class_GLTFState_method_get_animation_player:
  331. .. rst-class:: classref-method
  332. :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_animation_player>`
  333. Returns the :ref:`AnimationPlayer<class_AnimationPlayer>` node with the given index. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer<class_AnimationPlayer>` nodes to GLTF animations.
  334. .. rst-class:: classref-item-separator
  335. ----
  336. .. _class_GLTFState_method_get_animation_players_count:
  337. .. rst-class:: classref-method
  338. :ref:`int<class_int>` **get_animation_players_count**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_animation_players_count>`
  339. Returns the number of :ref:`AnimationPlayer<class_AnimationPlayer>` nodes in this **GLTFState**. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer<class_AnimationPlayer>` nodes to GLTF animations.
  340. .. rst-class:: classref-item-separator
  341. ----
  342. .. _class_GLTFState_method_get_animations:
  343. .. rst-class:: classref-method
  344. :ref:`Array<class_Array>`\[:ref:`GLTFAnimation<class_GLTFAnimation>`\] **get_animations**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_animations>`
  345. Returns an array of all :ref:`GLTFAnimation<class_GLTFAnimation>`\ s in the GLTF file. When importing, these will be generated as animations in an :ref:`AnimationPlayer<class_AnimationPlayer>` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer<class_AnimationPlayer>` nodes.
  346. .. rst-class:: classref-item-separator
  347. ----
  348. .. _class_GLTFState_method_get_buffer_views:
  349. .. rst-class:: classref-method
  350. :ref:`Array<class_Array>`\[:ref:`GLTFBufferView<class_GLTFBufferView>`\] **get_buffer_views**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_buffer_views>`
  351. .. container:: contribute
  352. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  353. .. rst-class:: classref-item-separator
  354. ----
  355. .. _class_GLTFState_method_get_cameras:
  356. .. rst-class:: classref-method
  357. :ref:`Array<class_Array>`\[:ref:`GLTFCamera<class_GLTFCamera>`\] **get_cameras**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_cameras>`
  358. Returns an array of all :ref:`GLTFCamera<class_GLTFCamera>`\ s in the GLTF file. These are the cameras that the :ref:`GLTFNode.camera<class_GLTFNode_property_camera>` index refers to.
  359. .. rst-class:: classref-item-separator
  360. ----
  361. .. _class_GLTFState_method_get_handle_binary_image:
  362. .. rst-class:: classref-method
  363. :ref:`int<class_int>` **get_handle_binary_image**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_handle_binary_image>`
  364. .. container:: contribute
  365. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  366. .. rst-class:: classref-item-separator
  367. ----
  368. .. _class_GLTFState_method_get_images:
  369. .. rst-class:: classref-method
  370. :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] **get_images**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_images>`
  371. Gets the images of the GLTF file as an array of :ref:`Texture2D<class_Texture2D>`\ s. These are the images that the :ref:`GLTFTexture.src_image<class_GLTFTexture_property_src_image>` index refers to.
  372. .. rst-class:: classref-item-separator
  373. ----
  374. .. _class_GLTFState_method_get_lights:
  375. .. rst-class:: classref-method
  376. :ref:`Array<class_Array>`\[:ref:`GLTFLight<class_GLTFLight>`\] **get_lights**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_lights>`
  377. Returns an array of all :ref:`GLTFLight<class_GLTFLight>`\ s in the GLTF file. These are the lights that the :ref:`GLTFNode.light<class_GLTFNode_property_light>` index refers to.
  378. .. rst-class:: classref-item-separator
  379. ----
  380. .. _class_GLTFState_method_get_materials:
  381. .. rst-class:: classref-method
  382. :ref:`Array<class_Array>`\[:ref:`Material<class_Material>`\] **get_materials**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_materials>`
  383. .. container:: contribute
  384. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  385. .. rst-class:: classref-item-separator
  386. ----
  387. .. _class_GLTFState_method_get_meshes:
  388. .. rst-class:: classref-method
  389. :ref:`Array<class_Array>`\[:ref:`GLTFMesh<class_GLTFMesh>`\] **get_meshes**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_meshes>`
  390. Returns an array of all :ref:`GLTFMesh<class_GLTFMesh>`\ es in the GLTF file. These are the meshes that the :ref:`GLTFNode.mesh<class_GLTFNode_property_mesh>` index refers to.
  391. .. rst-class:: classref-item-separator
  392. ----
  393. .. _class_GLTFState_method_get_node_index:
  394. .. rst-class:: classref-method
  395. :ref:`int<class_int>` **get_node_index**\ (\ scene_node\: :ref:`Node<class_Node>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_node_index>`
  396. Returns the index of the :ref:`GLTFNode<class_GLTFNode>` corresponding to this Godot scene node. This is the inverse of :ref:`get_scene_node<class_GLTFState_method_get_scene_node>`. Useful during the export process.
  397. \ **Note:** Not every Godot scene node will have a corresponding :ref:`GLTFNode<class_GLTFNode>`, and not every :ref:`GLTFNode<class_GLTFNode>` will have a scene node generated. If there is no :ref:`GLTFNode<class_GLTFNode>` index for this scene node, ``-1`` is returned.
  398. .. rst-class:: classref-item-separator
  399. ----
  400. .. _class_GLTFState_method_get_nodes:
  401. .. rst-class:: classref-method
  402. :ref:`Array<class_Array>`\[:ref:`GLTFNode<class_GLTFNode>`\] **get_nodes**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_nodes>`
  403. Returns an array of all :ref:`GLTFNode<class_GLTFNode>`\ s in the GLTF file. These are the nodes that :ref:`GLTFNode.children<class_GLTFNode_property_children>` and :ref:`root_nodes<class_GLTFState_property_root_nodes>` refer to. This includes nodes that may not be generated in the Godot scene, or nodes that may generate multiple Godot scene nodes.
  404. .. rst-class:: classref-item-separator
  405. ----
  406. .. _class_GLTFState_method_get_scene_node:
  407. .. rst-class:: classref-method
  408. :ref:`Node<class_Node>` **get_scene_node**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_scene_node>`
  409. Returns the Godot scene node that corresponds to the same index as the :ref:`GLTFNode<class_GLTFNode>` it was generated from. This is the inverse of :ref:`get_node_index<class_GLTFState_method_get_node_index>`. Useful during the import process.
  410. \ **Note:** Not every :ref:`GLTFNode<class_GLTFNode>` will have a scene node generated, and not every generated scene node will have a corresponding :ref:`GLTFNode<class_GLTFNode>`. If there is no scene node for this :ref:`GLTFNode<class_GLTFNode>` index, ``null`` is returned.
  411. .. rst-class:: classref-item-separator
  412. ----
  413. .. _class_GLTFState_method_get_skeletons:
  414. .. rst-class:: classref-method
  415. :ref:`Array<class_Array>`\[:ref:`GLTFSkeleton<class_GLTFSkeleton>`\] **get_skeletons**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_skeletons>`
  416. Returns an array of all :ref:`GLTFSkeleton<class_GLTFSkeleton>`\ s in the GLTF file. These are the skeletons that the :ref:`GLTFNode.skeleton<class_GLTFNode_property_skeleton>` index refers to.
  417. .. rst-class:: classref-item-separator
  418. ----
  419. .. _class_GLTFState_method_get_skins:
  420. .. rst-class:: classref-method
  421. :ref:`Array<class_Array>`\[:ref:`GLTFSkin<class_GLTFSkin>`\] **get_skins**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_skins>`
  422. Returns an array of all :ref:`GLTFSkin<class_GLTFSkin>`\ s in the GLTF file. These are the skins that the :ref:`GLTFNode.skin<class_GLTFNode_property_skin>` index refers to.
  423. .. rst-class:: classref-item-separator
  424. ----
  425. .. _class_GLTFState_method_get_texture_samplers:
  426. .. rst-class:: classref-method
  427. :ref:`Array<class_Array>`\[:ref:`GLTFTextureSampler<class_GLTFTextureSampler>`\] **get_texture_samplers**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_texture_samplers>`
  428. Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
  429. .. rst-class:: classref-item-separator
  430. ----
  431. .. _class_GLTFState_method_get_textures:
  432. .. rst-class:: classref-method
  433. :ref:`Array<class_Array>`\[:ref:`GLTFTexture<class_GLTFTexture>`\] **get_textures**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_textures>`
  434. .. container:: contribute
  435. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  436. .. rst-class:: classref-item-separator
  437. ----
  438. .. _class_GLTFState_method_get_unique_animation_names:
  439. .. rst-class:: classref-method
  440. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_unique_animation_names**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_unique_animation_names>`
  441. Returns an array of unique animation names. This is only used during the import process.
  442. .. rst-class:: classref-item-separator
  443. ----
  444. .. _class_GLTFState_method_get_unique_names:
  445. .. rst-class:: classref-method
  446. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_unique_names**\ (\ ) :ref:`๐Ÿ”—<class_GLTFState_method_get_unique_names>`
  447. Returns an array of unique node names. This is used in both the import process and export process.
  448. .. rst-class:: classref-item-separator
  449. ----
  450. .. _class_GLTFState_method_set_accessors:
  451. .. rst-class:: classref-method
  452. |void| **set_accessors**\ (\ accessors\: :ref:`Array<class_Array>`\[:ref:`GLTFAccessor<class_GLTFAccessor>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_accessors>`
  453. .. container:: contribute
  454. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  455. .. rst-class:: classref-item-separator
  456. ----
  457. .. _class_GLTFState_method_set_additional_data:
  458. .. rst-class:: classref-method
  459. |void| **set_additional_data**\ (\ extension_name\: :ref:`StringName<class_StringName>`, additional_data\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_additional_data>`
  460. 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.
  461. 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.
  462. .. rst-class:: classref-item-separator
  463. ----
  464. .. _class_GLTFState_method_set_animations:
  465. .. rst-class:: classref-method
  466. |void| **set_animations**\ (\ animations\: :ref:`Array<class_Array>`\[:ref:`GLTFAnimation<class_GLTFAnimation>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_animations>`
  467. Sets the :ref:`GLTFAnimation<class_GLTFAnimation>`\ s in the state. When importing, these will be generated as animations in an :ref:`AnimationPlayer<class_AnimationPlayer>` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer<class_AnimationPlayer>` nodes.
  468. .. rst-class:: classref-item-separator
  469. ----
  470. .. _class_GLTFState_method_set_buffer_views:
  471. .. rst-class:: classref-method
  472. |void| **set_buffer_views**\ (\ buffer_views\: :ref:`Array<class_Array>`\[:ref:`GLTFBufferView<class_GLTFBufferView>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_buffer_views>`
  473. .. container:: contribute
  474. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  475. .. rst-class:: classref-item-separator
  476. ----
  477. .. _class_GLTFState_method_set_cameras:
  478. .. rst-class:: classref-method
  479. |void| **set_cameras**\ (\ cameras\: :ref:`Array<class_Array>`\[:ref:`GLTFCamera<class_GLTFCamera>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_cameras>`
  480. Sets the :ref:`GLTFCamera<class_GLTFCamera>`\ s in the state. These are the cameras that the :ref:`GLTFNode.camera<class_GLTFNode_property_camera>` index refers to.
  481. .. rst-class:: classref-item-separator
  482. ----
  483. .. _class_GLTFState_method_set_handle_binary_image:
  484. .. rst-class:: classref-method
  485. |void| **set_handle_binary_image**\ (\ method\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_handle_binary_image>`
  486. .. container:: contribute
  487. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  488. .. rst-class:: classref-item-separator
  489. ----
  490. .. _class_GLTFState_method_set_images:
  491. .. rst-class:: classref-method
  492. |void| **set_images**\ (\ images\: :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_images>`
  493. Sets the images in the state stored as an array of :ref:`Texture2D<class_Texture2D>`\ s. This can be used during export. These are the images that the :ref:`GLTFTexture.src_image<class_GLTFTexture_property_src_image>` index refers to.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _class_GLTFState_method_set_lights:
  497. .. rst-class:: classref-method
  498. |void| **set_lights**\ (\ lights\: :ref:`Array<class_Array>`\[:ref:`GLTFLight<class_GLTFLight>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_lights>`
  499. Sets the :ref:`GLTFLight<class_GLTFLight>`\ s in the state. These are the lights that the :ref:`GLTFNode.light<class_GLTFNode_property_light>` index refers to.
  500. .. rst-class:: classref-item-separator
  501. ----
  502. .. _class_GLTFState_method_set_materials:
  503. .. rst-class:: classref-method
  504. |void| **set_materials**\ (\ materials\: :ref:`Array<class_Array>`\[:ref:`Material<class_Material>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_materials>`
  505. .. container:: contribute
  506. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  507. .. rst-class:: classref-item-separator
  508. ----
  509. .. _class_GLTFState_method_set_meshes:
  510. .. rst-class:: classref-method
  511. |void| **set_meshes**\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`GLTFMesh<class_GLTFMesh>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_meshes>`
  512. Sets the :ref:`GLTFMesh<class_GLTFMesh>`\ es in the state. These are the meshes that the :ref:`GLTFNode.mesh<class_GLTFNode_property_mesh>` index refers to.
  513. .. rst-class:: classref-item-separator
  514. ----
  515. .. _class_GLTFState_method_set_nodes:
  516. .. rst-class:: classref-method
  517. |void| **set_nodes**\ (\ nodes\: :ref:`Array<class_Array>`\[:ref:`GLTFNode<class_GLTFNode>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_nodes>`
  518. Sets the :ref:`GLTFNode<class_GLTFNode>`\ s in the state. These are the nodes that :ref:`GLTFNode.children<class_GLTFNode_property_children>` and :ref:`root_nodes<class_GLTFState_property_root_nodes>` refer to. Some of the nodes set here may not be generated in the Godot scene, or may generate multiple Godot scene nodes.
  519. .. rst-class:: classref-item-separator
  520. ----
  521. .. _class_GLTFState_method_set_skeletons:
  522. .. rst-class:: classref-method
  523. |void| **set_skeletons**\ (\ skeletons\: :ref:`Array<class_Array>`\[:ref:`GLTFSkeleton<class_GLTFSkeleton>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_skeletons>`
  524. Sets the :ref:`GLTFSkeleton<class_GLTFSkeleton>`\ s in the state. These are the skeletons that the :ref:`GLTFNode.skeleton<class_GLTFNode_property_skeleton>` index refers to.
  525. .. rst-class:: classref-item-separator
  526. ----
  527. .. _class_GLTFState_method_set_skins:
  528. .. rst-class:: classref-method
  529. |void| **set_skins**\ (\ skins\: :ref:`Array<class_Array>`\[:ref:`GLTFSkin<class_GLTFSkin>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_skins>`
  530. Sets the :ref:`GLTFSkin<class_GLTFSkin>`\ s in the state. These are the skins that the :ref:`GLTFNode.skin<class_GLTFNode_property_skin>` index refers to.
  531. .. rst-class:: classref-item-separator
  532. ----
  533. .. _class_GLTFState_method_set_texture_samplers:
  534. .. rst-class:: classref-method
  535. |void| **set_texture_samplers**\ (\ texture_samplers\: :ref:`Array<class_Array>`\[:ref:`GLTFTextureSampler<class_GLTFTextureSampler>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_texture_samplers>`
  536. Sets the array of texture samplers that are used by the textures contained in the GLTF.
  537. .. rst-class:: classref-item-separator
  538. ----
  539. .. _class_GLTFState_method_set_textures:
  540. .. rst-class:: classref-method
  541. |void| **set_textures**\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`GLTFTexture<class_GLTFTexture>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_textures>`
  542. .. container:: contribute
  543. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  544. .. rst-class:: classref-item-separator
  545. ----
  546. .. _class_GLTFState_method_set_unique_animation_names:
  547. .. rst-class:: classref-method
  548. |void| **set_unique_animation_names**\ (\ unique_animation_names\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_unique_animation_names>`
  549. Sets the unique animation names in the state. This is only used during the import process.
  550. .. rst-class:: classref-item-separator
  551. ----
  552. .. _class_GLTFState_method_set_unique_names:
  553. .. rst-class:: classref-method
  554. |void| **set_unique_names**\ (\ unique_names\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ ) :ref:`๐Ÿ”—<class_GLTFState_method_set_unique_names>`
  555. Sets the unique node names in the state. This is used in both the import process and export process.
  556. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  557. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  558. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  559. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  560. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  561. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  562. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  563. .. |void| replace:: :abbr:`void (No return value.)`