godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gltf/doc_classes/GLTFState.xml

256 lines
8.3 KiB
XML
Raw Normal View History

Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 16:51:38 +00:00
<class name="GLTFState" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<brief_description>
</brief_description>
<description>
Document that glTF classes are only usable in editor builds Run-time glTF saving/loading is only available in Godot 4.0, not Godot 3.x.
2022-04-22 17:07:23 +00:00
[b]Note:[/b] This class is only compiled in editor builds. Run-time glTF loading and saving is [i]not[/i] available in exported projects. References to [GLTFState] within a script will cause an error in an exported project.
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
</description>
<tutorials>
</tutorials>
<methods>
[3.x] Backport the GLTFDocumentExtension system
2022-12-10 20:09:56 +00:00
<method name="add_used_extension">
<return type="void" />
<argument index="0" name="extension_name" type="String" />
<argument index="1" name="required" type="bool" />
<description>
Appends an extension to the list of extensions used by this GLTF file during serialization. If [code]required[/code] is true, the extension will also be added to the list of required extensions. Do not run this in [method GLTFDocumentExtension._export_post], as that stage is too late to add extensions. The final list is sorted alphabetically.
</description>
</method>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<method name="get_accessors">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
[3.x] Backport the GLTFDocumentExtension system
2022-12-10 20:09:56 +00:00
<method name="get_additional_data">
<return type="Variant" />
<argument index="0" name="extension_name" type="String" />
<description>
Gets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
The argument should be the [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.
</description>
</method>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<method name="get_animation_player">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="AnimationPlayer" />
<argument index="0" name="idx" type="int" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_animation_players_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="idx" type="int" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_animations">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_buffer_views">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_cameras">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_images">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_lights">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_materials">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_nodes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_scene_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Node" />
<argument index="0" name="idx" type="int" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_skeleton_to_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_skeletons">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_skins">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
GLTF imports & exports material texture filters
2021-10-04 15:49:42 +00:00
<method name="get_texture_samplers">
<return type="Array" />
<description>
Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<method name="get_textures">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_unique_animation_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="get_unique_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_accessors">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="accessors" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
[3.x] Backport the GLTFDocumentExtension system
2022-12-10 20:09:56 +00:00
<method name="set_additional_data">
<return type="void" />
<argument index="0" name="extension_name" type="String" />
<argument index="1" name="additional_data" type="Variant" />
<description>
Sets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.
</description>
</method>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<method name="set_animations">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="animations" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_buffer_views">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="buffer_views" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_cameras">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="cameras" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_images">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="images" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_lights">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="lights" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_materials">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="materials" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="meshes" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_nodes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="nodes" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_skeleton_to_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="skeleton_to_node" type="Dictionary" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_skeletons">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="skeletons" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_skins">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="skins" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
GLTF imports & exports material texture filters
2021-10-04 15:49:42 +00:00
<method name="set_texture_samplers">
<return type="void" />
<argument index="0" name="texture_samplers" type="Array" />
<description>
Sets the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<method name="set_textures">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="textures" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_unique_animation_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="unique_animation_names" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="set_unique_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="unique_names" type="Array" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
</methods>
<members>
<member name="buffers" type="Array" setter="set_buffers" getter="get_buffers" default="[ ]">
</member>
Prevent AnimationPlayer from being added on GLTF import if the option is unchecked. Fixes #63954 (cherry picked from commit 805ffdfbf6841ac19c6fdbf3425a6ff15115bed7)
2022-08-09 17:39:58 +00:00
<member name="create_animations" type="bool" setter="set_create_animations" getter="get_create_animations" default="true">
</member>
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<member name="glb_data" type="PoolByteArray" setter="set_glb_data" getter="get_glb_data" default="PoolByteArray( )">
</member>
<member name="json" type="Dictionary" setter="set_json" getter="get_json" default="{}">
</member>
<member name="major_version" type="int" setter="set_major_version" getter="get_major_version" default="0">
</member>
<member name="minor_version" type="int" setter="set_minor_version" getter="get_minor_version" default="0">
</member>
<member name="root_nodes" type="Array" setter="set_root_nodes" getter="get_root_nodes" default="[ ]">
</member>
<member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default="&quot;&quot;">
</member>
<member name="use_named_skin_binds" type="bool" setter="set_use_named_skin_binds" getter="get_use_named_skin_binds" default="false">
</member>
</members>
<constants>
</constants>
</class>