class_gltfstate.rst 45 KB

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