class_gltfstate.rst 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/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. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. Properties
  13. ----------
  14. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  15. | :ref:`String<class_String>` | :ref:`base_path<class_GLTFState_property_base_path>` | ``""`` |
  16. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  17. | :ref:`PackedByteArray[]<class_PackedByteArray>` | :ref:`buffers<class_GLTFState_property_buffers>` | ``[]`` |
  18. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`create_animations<class_GLTFState_property_create_animations>` | ``true`` |
  20. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  21. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`glb_data<class_GLTFState_property_glb_data>` | ``PackedByteArray()`` |
  22. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  23. | :ref:`Dictionary<class_Dictionary>` | :ref:`json<class_GLTFState_property_json>` | ``{}`` |
  24. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  25. | :ref:`int<class_int>` | :ref:`major_version<class_GLTFState_property_major_version>` | ``0`` |
  26. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  27. | :ref:`int<class_int>` | :ref:`minor_version<class_GLTFState_property_minor_version>` | ``0`` |
  28. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  29. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`root_nodes<class_GLTFState_property_root_nodes>` | ``PackedInt32Array()`` |
  30. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  31. | :ref:`String<class_String>` | :ref:`scene_name<class_GLTFState_property_scene_name>` | ``""`` |
  32. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`use_named_skin_binds<class_GLTFState_property_use_named_skin_binds>` | ``false`` |
  34. +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+
  35. Methods
  36. -------
  37. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`add_used_extension<class_GLTFState_method_add_used_extension>` **(** :ref:`String<class_String>` extension_name, :ref:`bool<class_bool>` required **)** |
  39. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`GLTFAccessor[]<class_GLTFAccessor>` | :ref:`get_accessors<class_GLTFState_method_get_accessors>` **(** **)** |
  41. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Variant<class_Variant>` | :ref:`get_additional_data<class_GLTFState_method_get_additional_data>` **(** :ref:`StringName<class_StringName>` extension_name **)** |
  43. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`AnimationPlayer<class_AnimationPlayer>` | :ref:`get_animation_player<class_GLTFState_method_get_animation_player>` **(** :ref:`int<class_int>` idx **)** |
  45. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`int<class_int>` | :ref:`get_animation_players_count<class_GLTFState_method_get_animation_players_count>` **(** :ref:`int<class_int>` idx **)** |
  47. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`GLTFAnimation[]<class_GLTFAnimation>` | :ref:`get_animations<class_GLTFState_method_get_animations>` **(** **)** |
  49. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`GLTFBufferView[]<class_GLTFBufferView>` | :ref:`get_buffer_views<class_GLTFState_method_get_buffer_views>` **(** **)** |
  51. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`GLTFCamera[]<class_GLTFCamera>` | :ref:`get_cameras<class_GLTFState_method_get_cameras>` **(** **)** |
  53. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`Texture2D[]<class_Texture2D>` | :ref:`get_images<class_GLTFState_method_get_images>` **(** **)** |
  55. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`GLTFLight[]<class_GLTFLight>` | :ref:`get_lights<class_GLTFState_method_get_lights>` **(** **)** |
  57. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` | :ref:`get_materials<class_GLTFState_method_get_materials>` **(** **)** |
  59. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`GLTFMesh[]<class_GLTFMesh>` | :ref:`get_meshes<class_GLTFState_method_get_meshes>` **(** **)** |
  61. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`GLTFNode[]<class_GLTFNode>` | :ref:`get_nodes<class_GLTFState_method_get_nodes>` **(** **)** |
  63. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Node<class_Node>` | :ref:`get_scene_node<class_GLTFState_method_get_scene_node>` **(** :ref:`int<class_int>` idx **)** |
  65. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_skeleton_to_node<class_GLTFState_method_get_skeleton_to_node>` **(** **)** |
  67. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` | :ref:`get_skeletons<class_GLTFState_method_get_skeletons>` **(** **)** |
  69. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`GLTFSkin[]<class_GLTFSkin>` | :ref:`get_skins<class_GLTFState_method_get_skins>` **(** **)** |
  71. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` | :ref:`get_texture_samplers<class_GLTFState_method_get_texture_samplers>` **(** **)** |
  73. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`GLTFTexture[]<class_GLTFTexture>` | :ref:`get_textures<class_GLTFState_method_get_textures>` **(** **)** |
  75. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`String[]<class_String>` | :ref:`get_unique_animation_names<class_GLTFState_method_get_unique_animation_names>` **(** **)** |
  77. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`String[]<class_String>` | :ref:`get_unique_names<class_GLTFState_method_get_unique_names>` **(** **)** |
  79. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | void | :ref:`set_accessors<class_GLTFState_method_set_accessors>` **(** :ref:`GLTFAccessor[]<class_GLTFAccessor>` accessors **)** |
  81. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | void | :ref:`set_additional_data<class_GLTFState_method_set_additional_data>` **(** :ref:`StringName<class_StringName>` extension_name, :ref:`Variant<class_Variant>` additional_data **)** |
  83. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | void | :ref:`set_animations<class_GLTFState_method_set_animations>` **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)** |
  85. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | void | :ref:`set_buffer_views<class_GLTFState_method_set_buffer_views>` **(** :ref:`GLTFBufferView[]<class_GLTFBufferView>` buffer_views **)** |
  87. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | void | :ref:`set_cameras<class_GLTFState_method_set_cameras>` **(** :ref:`GLTFCamera[]<class_GLTFCamera>` cameras **)** |
  89. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | void | :ref:`set_images<class_GLTFState_method_set_images>` **(** :ref:`Texture2D[]<class_Texture2D>` images **)** |
  91. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | void | :ref:`set_lights<class_GLTFState_method_set_lights>` **(** :ref:`GLTFLight[]<class_GLTFLight>` lights **)** |
  93. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | void | :ref:`set_materials<class_GLTFState_method_set_materials>` **(** :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` materials **)** |
  95. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | void | :ref:`set_meshes<class_GLTFState_method_set_meshes>` **(** :ref:`GLTFMesh[]<class_GLTFMesh>` meshes **)** |
  97. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | void | :ref:`set_nodes<class_GLTFState_method_set_nodes>` **(** :ref:`GLTFNode[]<class_GLTFNode>` nodes **)** |
  99. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | void | :ref:`set_skeleton_to_node<class_GLTFState_method_set_skeleton_to_node>` **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)** |
  101. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | void | :ref:`set_skeletons<class_GLTFState_method_set_skeletons>` **(** :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` skeletons **)** |
  103. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | void | :ref:`set_skins<class_GLTFState_method_set_skins>` **(** :ref:`GLTFSkin[]<class_GLTFSkin>` skins **)** |
  105. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | void | :ref:`set_texture_samplers<class_GLTFState_method_set_texture_samplers>` **(** :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` texture_samplers **)** |
  107. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | void | :ref:`set_textures<class_GLTFState_method_set_textures>` **(** :ref:`GLTFTexture[]<class_GLTFTexture>` textures **)** |
  109. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | void | :ref:`set_unique_animation_names<class_GLTFState_method_set_unique_animation_names>` **(** :ref:`String[]<class_String>` unique_animation_names **)** |
  111. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | void | :ref:`set_unique_names<class_GLTFState_method_set_unique_names>` **(** :ref:`String[]<class_String>` unique_names **)** |
  113. +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. Property Descriptions
  115. ---------------------
  116. .. _class_GLTFState_property_base_path:
  117. - :ref:`String<class_String>` **base_path**
  118. +-----------+----------------------+
  119. | *Default* | ``""`` |
  120. +-----------+----------------------+
  121. | *Setter* | set_base_path(value) |
  122. +-----------+----------------------+
  123. | *Getter* | get_base_path() |
  124. +-----------+----------------------+
  125. .. container:: contribute
  126. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  127. ----
  128. .. _class_GLTFState_property_buffers:
  129. - :ref:`PackedByteArray[]<class_PackedByteArray>` **buffers**
  130. +-----------+--------------------+
  131. | *Default* | ``[]`` |
  132. +-----------+--------------------+
  133. | *Setter* | set_buffers(value) |
  134. +-----------+--------------------+
  135. | *Getter* | get_buffers() |
  136. +-----------+--------------------+
  137. .. container:: contribute
  138. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  139. ----
  140. .. _class_GLTFState_property_create_animations:
  141. - :ref:`bool<class_bool>` **create_animations**
  142. +-----------+------------------------------+
  143. | *Default* | ``true`` |
  144. +-----------+------------------------------+
  145. | *Setter* | set_create_animations(value) |
  146. +-----------+------------------------------+
  147. | *Getter* | get_create_animations() |
  148. +-----------+------------------------------+
  149. .. container:: contribute
  150. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  151. ----
  152. .. _class_GLTFState_property_glb_data:
  153. - :ref:`PackedByteArray<class_PackedByteArray>` **glb_data**
  154. +-----------+-----------------------+
  155. | *Default* | ``PackedByteArray()`` |
  156. +-----------+-----------------------+
  157. | *Setter* | set_glb_data(value) |
  158. +-----------+-----------------------+
  159. | *Getter* | get_glb_data() |
  160. +-----------+-----------------------+
  161. .. container:: contribute
  162. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  163. ----
  164. .. _class_GLTFState_property_json:
  165. - :ref:`Dictionary<class_Dictionary>` **json**
  166. +-----------+-----------------+
  167. | *Default* | ``{}`` |
  168. +-----------+-----------------+
  169. | *Setter* | set_json(value) |
  170. +-----------+-----------------+
  171. | *Getter* | get_json() |
  172. +-----------+-----------------+
  173. .. container:: contribute
  174. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  175. ----
  176. .. _class_GLTFState_property_major_version:
  177. - :ref:`int<class_int>` **major_version**
  178. +-----------+--------------------------+
  179. | *Default* | ``0`` |
  180. +-----------+--------------------------+
  181. | *Setter* | set_major_version(value) |
  182. +-----------+--------------------------+
  183. | *Getter* | get_major_version() |
  184. +-----------+--------------------------+
  185. .. container:: contribute
  186. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  187. ----
  188. .. _class_GLTFState_property_minor_version:
  189. - :ref:`int<class_int>` **minor_version**
  190. +-----------+--------------------------+
  191. | *Default* | ``0`` |
  192. +-----------+--------------------------+
  193. | *Setter* | set_minor_version(value) |
  194. +-----------+--------------------------+
  195. | *Getter* | get_minor_version() |
  196. +-----------+--------------------------+
  197. .. container:: contribute
  198. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  199. ----
  200. .. _class_GLTFState_property_root_nodes:
  201. - :ref:`PackedInt32Array<class_PackedInt32Array>` **root_nodes**
  202. +-----------+------------------------+
  203. | *Default* | ``PackedInt32Array()`` |
  204. +-----------+------------------------+
  205. | *Setter* | set_root_nodes(value) |
  206. +-----------+------------------------+
  207. | *Getter* | get_root_nodes() |
  208. +-----------+------------------------+
  209. .. container:: contribute
  210. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  211. ----
  212. .. _class_GLTFState_property_scene_name:
  213. - :ref:`String<class_String>` **scene_name**
  214. +-----------+-----------------------+
  215. | *Default* | ``""`` |
  216. +-----------+-----------------------+
  217. | *Setter* | set_scene_name(value) |
  218. +-----------+-----------------------+
  219. | *Getter* | get_scene_name() |
  220. +-----------+-----------------------+
  221. .. container:: contribute
  222. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  223. ----
  224. .. _class_GLTFState_property_use_named_skin_binds:
  225. - :ref:`bool<class_bool>` **use_named_skin_binds**
  226. +-----------+---------------------------------+
  227. | *Default* | ``false`` |
  228. +-----------+---------------------------------+
  229. | *Setter* | set_use_named_skin_binds(value) |
  230. +-----------+---------------------------------+
  231. | *Getter* | get_use_named_skin_binds() |
  232. +-----------+---------------------------------+
  233. .. container:: contribute
  234. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  235. Method Descriptions
  236. -------------------
  237. .. _class_GLTFState_method_add_used_extension:
  238. - void **add_used_extension** **(** :ref:`String<class_String>` extension_name, :ref:`bool<class_bool>` required **)**
  239. 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_method__export_post>`, as that stage is too late to add extensions. The final list is sorted alphabetically.
  240. ----
  241. .. _class_GLTFState_method_get_accessors:
  242. - :ref:`GLTFAccessor[]<class_GLTFAccessor>` **get_accessors** **(** **)**
  243. .. container:: contribute
  244. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  245. ----
  246. .. _class_GLTFState_method_get_additional_data:
  247. - :ref:`Variant<class_Variant>` **get_additional_data** **(** :ref:`StringName<class_StringName>` extension_name **)**
  248. 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.
  249. 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.
  250. ----
  251. .. _class_GLTFState_method_get_animation_player:
  252. - :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player** **(** :ref:`int<class_int>` idx **)**
  253. .. container:: contribute
  254. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  255. ----
  256. .. _class_GLTFState_method_get_animation_players_count:
  257. - :ref:`int<class_int>` **get_animation_players_count** **(** :ref:`int<class_int>` idx **)**
  258. .. container:: contribute
  259. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  260. ----
  261. .. _class_GLTFState_method_get_animations:
  262. - :ref:`GLTFAnimation[]<class_GLTFAnimation>` **get_animations** **(** **)**
  263. .. container:: contribute
  264. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  265. ----
  266. .. _class_GLTFState_method_get_buffer_views:
  267. - :ref:`GLTFBufferView[]<class_GLTFBufferView>` **get_buffer_views** **(** **)**
  268. .. container:: contribute
  269. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  270. ----
  271. .. _class_GLTFState_method_get_cameras:
  272. - :ref:`GLTFCamera[]<class_GLTFCamera>` **get_cameras** **(** **)**
  273. .. container:: contribute
  274. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  275. ----
  276. .. _class_GLTFState_method_get_images:
  277. - :ref:`Texture2D[]<class_Texture2D>` **get_images** **(** **)**
  278. .. container:: contribute
  279. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  280. ----
  281. .. _class_GLTFState_method_get_lights:
  282. - :ref:`GLTFLight[]<class_GLTFLight>` **get_lights** **(** **)**
  283. .. container:: contribute
  284. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  285. ----
  286. .. _class_GLTFState_method_get_materials:
  287. - :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` **get_materials** **(** **)**
  288. .. container:: contribute
  289. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  290. ----
  291. .. _class_GLTFState_method_get_meshes:
  292. - :ref:`GLTFMesh[]<class_GLTFMesh>` **get_meshes** **(** **)**
  293. .. container:: contribute
  294. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  295. ----
  296. .. _class_GLTFState_method_get_nodes:
  297. - :ref:`GLTFNode[]<class_GLTFNode>` **get_nodes** **(** **)**
  298. .. container:: contribute
  299. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  300. ----
  301. .. _class_GLTFState_method_get_scene_node:
  302. - :ref:`Node<class_Node>` **get_scene_node** **(** :ref:`int<class_int>` idx **)**
  303. .. container:: contribute
  304. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  305. ----
  306. .. _class_GLTFState_method_get_skeleton_to_node:
  307. - :ref:`Dictionary<class_Dictionary>` **get_skeleton_to_node** **(** **)**
  308. .. container:: contribute
  309. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  310. ----
  311. .. _class_GLTFState_method_get_skeletons:
  312. - :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` **get_skeletons** **(** **)**
  313. .. container:: contribute
  314. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  315. ----
  316. .. _class_GLTFState_method_get_skins:
  317. - :ref:`GLTFSkin[]<class_GLTFSkin>` **get_skins** **(** **)**
  318. .. container:: contribute
  319. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  320. ----
  321. .. _class_GLTFState_method_get_texture_samplers:
  322. - :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` **get_texture_samplers** **(** **)**
  323. Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
  324. ----
  325. .. _class_GLTFState_method_get_textures:
  326. - :ref:`GLTFTexture[]<class_GLTFTexture>` **get_textures** **(** **)**
  327. .. container:: contribute
  328. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  329. ----
  330. .. _class_GLTFState_method_get_unique_animation_names:
  331. - :ref:`String[]<class_String>` **get_unique_animation_names** **(** **)**
  332. .. container:: contribute
  333. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  334. ----
  335. .. _class_GLTFState_method_get_unique_names:
  336. - :ref:`String[]<class_String>` **get_unique_names** **(** **)**
  337. .. container:: contribute
  338. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  339. ----
  340. .. _class_GLTFState_method_set_accessors:
  341. - void **set_accessors** **(** :ref:`GLTFAccessor[]<class_GLTFAccessor>` accessors **)**
  342. .. container:: contribute
  343. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  344. ----
  345. .. _class_GLTFState_method_set_additional_data:
  346. - void **set_additional_data** **(** :ref:`StringName<class_StringName>` extension_name, :ref:`Variant<class_Variant>` additional_data **)**
  347. 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.
  348. 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.
  349. ----
  350. .. _class_GLTFState_method_set_animations:
  351. - void **set_animations** **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)**
  352. .. container:: contribute
  353. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  354. ----
  355. .. _class_GLTFState_method_set_buffer_views:
  356. - void **set_buffer_views** **(** :ref:`GLTFBufferView[]<class_GLTFBufferView>` buffer_views **)**
  357. .. container:: contribute
  358. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  359. ----
  360. .. _class_GLTFState_method_set_cameras:
  361. - void **set_cameras** **(** :ref:`GLTFCamera[]<class_GLTFCamera>` cameras **)**
  362. .. container:: contribute
  363. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  364. ----
  365. .. _class_GLTFState_method_set_images:
  366. - void **set_images** **(** :ref:`Texture2D[]<class_Texture2D>` images **)**
  367. .. container:: contribute
  368. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  369. ----
  370. .. _class_GLTFState_method_set_lights:
  371. - void **set_lights** **(** :ref:`GLTFLight[]<class_GLTFLight>` lights **)**
  372. .. container:: contribute
  373. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  374. ----
  375. .. _class_GLTFState_method_set_materials:
  376. - void **set_materials** **(** :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` materials **)**
  377. .. container:: contribute
  378. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  379. ----
  380. .. _class_GLTFState_method_set_meshes:
  381. - void **set_meshes** **(** :ref:`GLTFMesh[]<class_GLTFMesh>` meshes **)**
  382. .. container:: contribute
  383. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  384. ----
  385. .. _class_GLTFState_method_set_nodes:
  386. - void **set_nodes** **(** :ref:`GLTFNode[]<class_GLTFNode>` nodes **)**
  387. .. container:: contribute
  388. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  389. ----
  390. .. _class_GLTFState_method_set_skeleton_to_node:
  391. - void **set_skeleton_to_node** **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)**
  392. .. container:: contribute
  393. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  394. ----
  395. .. _class_GLTFState_method_set_skeletons:
  396. - void **set_skeletons** **(** :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` skeletons **)**
  397. .. container:: contribute
  398. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  399. ----
  400. .. _class_GLTFState_method_set_skins:
  401. - void **set_skins** **(** :ref:`GLTFSkin[]<class_GLTFSkin>` skins **)**
  402. .. container:: contribute
  403. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  404. ----
  405. .. _class_GLTFState_method_set_texture_samplers:
  406. - void **set_texture_samplers** **(** :ref:`GLTFTextureSampler[]<class_GLTFTextureSampler>` texture_samplers **)**
  407. Sets the array of texture samplers that are used by the textures contained in the GLTF.
  408. ----
  409. .. _class_GLTFState_method_set_textures:
  410. - void **set_textures** **(** :ref:`GLTFTexture[]<class_GLTFTexture>` textures **)**
  411. .. container:: contribute
  412. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  413. ----
  414. .. _class_GLTFState_method_set_unique_animation_names:
  415. - void **set_unique_animation_names** **(** :ref:`String[]<class_String>` unique_animation_names **)**
  416. .. container:: contribute
  417. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  418. ----
  419. .. _class_GLTFState_method_set_unique_names:
  420. - void **set_unique_names** **(** :ref:`String[]<class_String>` unique_names **)**
  421. .. container:: contribute
  422. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  423. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  424. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  425. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  426. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  427. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  428. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`