Add three new methods to GLTFDocumentExtension

1 files changed, 45 insertions, 1 deletions

diff --git a/modules/gltf/doc_classes/GLTFDocumentExtension.xml b/modules/gltf/doc_classes/GLTFDocumentExtension.xml
index adc32df8dc..87d3d9bcb0 100644
--- a/modules/gltf/doc_classes/GLTFDocumentExtension.xml
+++ b/modules/gltf/doc_classes/GLTFDocumentExtension.xml
@@ -11,6 +11,16 @@
 	<tutorials>
 	</tutorials>
 	<methods>
+		<method name="_convert_scene_node" qualifiers="virtual">
+			<return type="void" />
+			<param index="0" name="state" type="GLTFState" />
+			<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].
+				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>
 		<method name="_export_node" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="state" type="GLTFState" />
@@ -18,23 +28,40 @@
 			<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].
+				This method can be used to modify the final JSON of each node.
 			</description>
 		</method>
 		<method name="_export_post" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="state" type="GLTFState" />
 			<description>
+				Part of the export process. This method is run last, after all other parts of the export process.
+				This method can be used to modify the final JSON of the generated GLTF file.
 			</description>
 		</method>
 		<method name="_export_preflight" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="root" type="Node" />
 			<description>
+				Part of the export process. This method is run first, before all other parts of the export process.
+				The return value is used to determine if this GLTFDocumentExtension class should be used for exporting a given GLTF file. If [constant OK], the export will use this GLTFDocumentExtension class. If not overridden, [constant OK] is returned.
+			</description>
+		</method>
+		<method name="_generate_scene_node" qualifiers="virtual">
+			<return type="Node3D" />
+			<param index="0" name="state" type="GLTFState" />
+			<param index="1" name="gltf_node" type="GLTFNode" />
+			<param index="2" name="scene_parent" type="Node" />
+			<description>
+				Part of the import process. This method is run after [method _parse_node_extensions] and before [method _import_post_parse].
+				Runs when generating a Godot scene node from a GLTFNode. The returned node will be added to the scene tree. Multiple nodes can be generated in this step if they are added as a child of the returned node.
 			</description>
 		</method>
 		<method name="_get_supported_extensions" qualifiers="virtual">
 			<return type="PackedStringArray" />
 			<description>
+				Part of the import process. This method is run after [method _import_preflight] and before [method _parse_node_extensions].
 				Returns an array of the GLTF extensions supported by this GLTFDocumentExtension class. This is used to validate if a GLTF file with required extensions can be loaded.
 			</description>
 		</method>
@@ -45,6 +72,8 @@
 			<param index="2" name="json" type="Dictionary" />
 			<param index="3" name="node" type="Node" />
 			<description>
+				Part of the import process. This method is run after [method _import_post_parse] and before [method _import_post].
+				This method can be used to make modifications to each of the generated Godot scene nodes.
 			</description>
 		</method>
 		<method name="_import_post" qualifiers="virtual">
@@ -52,12 +81,16 @@
 			<param index="0" name="state" type="GLTFState" />
 			<param index="1" name="root" type="Node" />
 			<description>
+				Part of the import process. This method is run last, after all other parts of the import process.
+				This method can be used to modify the final Godot scene generated by the import process.
 			</description>
 		</method>
 		<method name="_import_post_parse" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="state" type="GLTFState" />
 			<description>
+				Part of the import process. This method is run after [method _generate_scene_node] and before [method _import_node].
+				This method can be used to modify any of the data imported so far, including any scene nodes, before running the final per-node import step.
 			</description>
 		</method>
 		<method name="_import_preflight" qualifiers="virtual">
@@ -65,7 +98,18 @@
 			<param index="0" name="state" type="GLTFState" />
 			<param index="1" name="extensions" type="PackedStringArray" />
 			<description>
-				This callback is run first. It is used to determine if this GLTFDocumentExtension class should be used for importing a given GLTF file. If [constant OK], the import will use this GLTFDocumentExtension class.
+				Part of the import process. This method is run first, before all other parts of the import process.
+				The return value is used to determine if this GLTFDocumentExtension class should be used for importing a given GLTF file. If [constant OK], the import will use this GLTFDocumentExtension class. If not overridden, [constant OK] is returned.
+			</description>
+		</method>
+		<method name="_parse_node_extensions" qualifiers="virtual">
+			<return type="int" />
+			<param index="0" name="state" type="GLTFState" />
+			<param index="1" name="gltf_node" type="GLTFNode" />
+			<param index="2" name="extensions" type="Dictionary" />
+			<description>
+				Part of the import process. This method is run after [method _get_supported_extensions] and before [method _generate_scene_node].
+				Runs when parsing the node extensions of a GLTFNode. This method can be used to process the extension JSON data into a format that can be used by [method _generate_scene_node].
 			</description>
 		</method>
 	</methods>