summaryrefslogtreecommitdiffstats
path: root/modules/gltf/doc_classes/GLTFDocumentExtension.xml
diff options
context:
space:
mode:
authorAaron Franke <arnfranke@yahoo.com>2023-07-18 11:15:58 -0500
committerAaron Franke <arnfranke@yahoo.com>2023-07-18 15:20:24 -0500
commite8906b5b80312dd03599813c1c99fc834d747699 (patch)
treeb5a8d5a6e70c43f58fba526d15a43247560d18ed /modules/gltf/doc_classes/GLTFDocumentExtension.xml
parent8f175a8649fd5d83a8679651a2078ded496d61c0 (diff)
downloadredot-engine-e8906b5b80312dd03599813c1c99fc834d747699.tar.gz
Add export_preserialize to the GLTF export process
Diffstat (limited to 'modules/gltf/doc_classes/GLTFDocumentExtension.xml')
-rw-r--r--modules/gltf/doc_classes/GLTFDocumentExtension.xml12
1 files changed, 10 insertions, 2 deletions
diff --git a/modules/gltf/doc_classes/GLTFDocumentExtension.xml b/modules/gltf/doc_classes/GLTFDocumentExtension.xml
index 927ffb6aae..24a86fdb75 100644
--- a/modules/gltf/doc_classes/GLTFDocumentExtension.xml
+++ b/modules/gltf/doc_classes/GLTFDocumentExtension.xml
@@ -17,7 +17,7 @@
<param index="1" name="gltf_node" type="GLTFNode" />
<param index="2" name="scene_node" type="Node" />
<description>
- Part of the export process. This method is run after [method _export_preflight] and before [method _export_node].
+ Part of the export process. This method is run after [method _export_preflight] and before [method _export_preserialize].
Runs when converting the data from a Godot scene node. This method can be used to process the Godot scene node data into a format that can be used by [method _export_node].
</description>
</method>
@@ -28,7 +28,7 @@
<param index="2" name="json" type="Dictionary" />
<param index="3" name="node" type="Node" />
<description>
- Part of the export process. This method is run after [method _convert_scene_node] and before [method _export_post].
+ Part of the export process. This method is run after [method _export_preserialize] and before [method _export_post].
This method can be used to modify the final JSON of each node.
</description>
</method>
@@ -49,6 +49,14 @@
The return value is used to determine if this [GLTFDocumentExtension] instance should be used for exporting a given GLTF file. If [constant OK], the export will use this [GLTFDocumentExtension] instance. If not overridden, [constant OK] is returned.
</description>
</method>
+ <method name="_export_preserialize" qualifiers="virtual">
+ <return type="int" enum="Error" />
+ <param index="0" name="state" type="GLTFState" />
+ <description>
+ Part of the export process. This method is run after [method _convert_scene_node] and before [method _export_node].
+ This method can be used to alter the state before performing serialization. It runs every time when generating a buffer with [method GLTFDocument.generate_buffer] or writing to the file system with [method GLTFDocument.write_to_filesystem].
+ </description>
+ </method>
<method name="_generate_scene_node" qualifiers="virtual">
<return type="Node3D" />
<param index="0" name="state" type="GLTFState" />