summaryrefslogtreecommitdiff
path: root/doc/classes/EditorFileSystem.xml
blob: f5a3bf7ecaf420f6b39bee24f4491a5fd48a8232 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFileSystem" inherits="Node" category="Core" version="3.1-dev">
	<brief_description>
		Resource filesystem, as the editor sees it.
	</brief_description>
	<description>
		This object holds information of all resources in the filesystem, their types, etc.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_file_type" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Get the type of the file, given the full path.
			</description>
		</method>
		<method name="get_filesystem">
			<return type="EditorFileSystemDirectory">
			</return>
			<description>
				Get the root directory object.
			</description>
		</method>
		<method name="get_filesystem_path">
			<return type="EditorFileSystemDirectory">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Returns a view into the filesystem at [code]path[/code].
			</description>
		</method>
		<method name="get_scanning_progress" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the scan progress for 0 to 1 if the FS is being scanned.
			</description>
		</method>
		<method name="is_scanning" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Return true of the filesystem is being scanned.
			</description>
		</method>
		<method name="scan">
			<return type="void">
			</return>
			<description>
				Scan the filesystem for changes.
			</description>
		</method>
		<method name="scan_sources">
			<return type="void">
			</return>
			<description>
				Check if the source of any imported resource changed.
			</description>
		</method>
		<method name="update_file">
			<return type="void">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Update a file information. Call this if an external program (not Godot) modified the file.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="filesystem_changed">
			<description>
				Emitted if the filesystem changed.
			</description>
		</signal>
		<signal name="resources_reimported">
			<argument index="0" name="resources" type="PoolStringArray">
			</argument>
			<description>
				Remitted if a resource is reimported.
			</description>
		</signal>
		<signal name="sources_changed">
			<argument index="0" name="exist" type="bool">
			</argument>
			<description>
				Emitted if the source of any imported file changed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>