asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve the documentation of GLTFDocument's append methods

Browse source
This commit is contained in:
Aaron Franke 2023-01-15 14:26:12 -06:00
parent 91fedb60de
commit 208df30eeb
No known key found for this signature in database
GPG key ID: 40A1750B977E56BF
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
modules/gltf/doc_classes/GLTFDocument.xml
View file

@ -15,7 +15,7 @@
<param index="2" name="state" type="GLTFState" /> <param index="2" name="state" type="GLTFState" />
<param index="3" name="flags" type="int" default="0" /> <param index="3" name="flags" type="int" default="0" />
<description> <description>
Takes a [PackedByteArray] defining a gLTF and returns a [GLTFState] object through the [param state] parameter. Takes a [PackedByteArray] defining a GLTF and imports the data to the given [GLTFState] object through the [param state] parameter.
[b]Note:[/b] The [param base_path] tells [method append_from_buffer] where to find dependencies and can be empty. [b]Note:[/b] The [param base_path] tells [method append_from_buffer] where to find dependencies and can be empty.
</description> </description>
</method> </method>
@ -26,7 +26,7 @@
<param index="2" name="flags" type="int" default="0" /> <param index="2" name="flags" type="int" default="0" />
<param index="3" name="base_path" type="String" default="&quot;&quot;" /> <param index="3" name="base_path" type="String" default="&quot;&quot;" />
<description> <description>
Takes a path to a gLTF file and returns a [GLTFState] object through the [param state] parameter. Takes a path to a GLTF file and imports the data at that file path to the given [GLTFState] object through the [param state] parameter.
[b]Note:[/b] The [param base_path] tells [method append_from_file] where to find dependencies and can be empty. [b]Note:[/b] The [param base_path] tells [method append_from_file] where to find dependencies and can be empty.
</description> </description>
</method> </method>
@ -36,14 +36,14 @@
<param index="1" name="state" type="GLTFState" /> <param index="1" name="state" type="GLTFState" />
<param index="2" name="flags" type="int" default="0" /> <param index="2" name="flags" type="int" default="0" />
<description> <description>
Takes a Godot Engine scene node and returns a [GLTFState] object through the [param state] parameter. Takes a Godot Engine scene node and exports it and its descendants to the given [GLTFState] object through the [param state] parameter.
</description> </description>
</method> </method>
<method name="generate_buffer"> <method name="generate_buffer">
<return type="PackedByteArray" /> <return type="PackedByteArray" />
<param index="0" name="state" type="GLTFState" /> <param index="0" name="state" type="GLTFState" />
<description> <description>
Takes a [GLTFState] object through the [param state] parameter and returns a gLTF [PackedByteArray]. Takes a [GLTFState] object through the [param state] parameter and returns a GLTF [PackedByteArray].
</description> </description>
</method> </method>
<method name="generate_scene"> <method name="generate_scene">