summaryrefslogtreecommitdiff
path: root/modules/gltf/doc_classes/GLTFDocumentExtension.xml
blob: 936794976d7e26607bb396c1311d0291783b33a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFDocumentExtension" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		[GLTFDocument] extension class.
	</brief_description>
	<description>
		Extends the functionality of the [GLTFDocument] class by allowing you to run arbitrary code at various stages of GLTF import or export.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_export_node" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<param index="1" name="gltf_node" type="GLTFNode" />
			<param index="2" name="json" type="Dictionary" />
			<param index="3" name="node" type="Node" />
			<description>
			</description>
		</method>
		<method name="_export_post" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<description>
			</description>
		</method>
		<method name="_export_preflight" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="root" type="Node" />
			<description>
			</description>
		</method>
		<method name="_get_supported_extensions" qualifiers="virtual">
			<return type="PackedStringArray" />
			<description>
				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>
		<method name="_import_node" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<param index="1" name="gltf_node" type="GLTFNode" />
			<param index="2" name="json" type="Dictionary" />
			<param index="3" name="node" type="Node" />
			<description>
			</description>
		</method>
		<method name="_import_post" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<param index="1" name="root" type="Node" />
			<description>
			</description>
		</method>
		<method name="_import_post_parse" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<description>
			</description>
		</method>
		<method name="_import_preflight" qualifiers="virtual">
			<return type="int" />
			<param index="0" name="state" type="GLTFState" />
			<description>
			</description>
		</method>
	</methods>
</class>