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

47 lines
2.2 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="PackedSceneGLTF" inherits="PackedScene" version="3.5" 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 [PackedSceneGLTF] 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>
<method name="export_gltf">
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" enum="Error" />
<argument index="0" name="node" type="Node" />
<argument index="1" name="path" type="String" />
<argument index="2" name="flags" type="int" default="0" />
<argument index="3" name="bake_fps" type="float" default="1000.0" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="import_gltf_scene">
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="path" type="String" />
<argument index="1" name="flags" type="int" default="0" />
<argument index="2" name="bake_fps" type="float" default="1000.0" />
Added Mesh Compression Import Options Fleshed out the "Optimize Mesh" options found in the mesh import UI Gave a checkbox to every vertex attribute that can be compressed Surfaced option to enable/disable Octahedral compression for normal/tangent vectors Also surfaces the vertex position compression option which previously inaccessible because the defaults did not compress vertex positions Supports all current importers (obj, fbx, collada, gltf)
2021-05-10 20:51:11 +00:00
<argument index="3" name="compress_flags" type="int" default="2194432" />
<argument index="4" name="state" type="GLTFState" default="null" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
<method name="pack_gltf">
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="path" type="String" />
<argument index="1" name="flags" type="int" default="0" />
<argument index="2" name="bake_fps" type="float" default="1000.0" />
Added Mesh Compression Import Options Fleshed out the "Optimize Mesh" options found in the mesh import UI Gave a checkbox to every vertex attribute that can be compressed Surfaced option to enable/disable Octahedral compression for normal/tangent vectors Also surfaces the vertex position compression option which previously inaccessible because the defaults did not compress vertex positions Supports all current importers (obj, fbx, collada, gltf)
2021-05-10 20:51:11 +00:00
<argument index="3" name="compress_flags" type="int" default="2194432" />
<argument index="4" name="state" type="GLTFState" default="null" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
<description>
</description>
</method>
</methods>
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:15:17 +00:00
<member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene" overrides="PackedScene" default="{&quot;conn_count&quot;: 0,&quot;conns&quot;: PoolIntArray( ),&quot;editable_instances&quot;: [ ],&quot;names&quot;: PoolStringArray( ),&quot;node_count&quot;: 0,&quot;node_paths&quot;: [ ],&quot;nodes&quot;: PoolIntArray( ),&quot;variants&quot;: [ ],&quot;version&quot;: 2}" />
Backport gltf2 module from master.
2021-03-03 04:20:20 +00:00
</members>
<constants>
</constants>
</class>