summaryrefslogtreecommitdiff
path: root/doc/classes/EditorFileSystemDirectory.xml
blob: e9a0e3310c6728d6e91327257c2f8a09268ed20f (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
101
102
103
104
105
106
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFileSystemDirectory" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A directory for the resource filesystem.
	</brief_description>
	<description>
		A more generalized, low-level variation of the directory concept.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="find_dir_index" qualifiers="const">
			<return type="int" />
			<param index="0" name="name" type="String" />
			<description>
				Returns the index of the directory with name [param name] or [code]-1[/code] if not found.
			</description>
		</method>
		<method name="find_file_index" qualifiers="const">
			<return type="int" />
			<param index="0" name="name" type="String" />
			<description>
				Returns the index of the file with name [param name] or [code]-1[/code] if not found.
			</description>
		</method>
		<method name="get_file" qualifiers="const">
			<return type="String" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the name of the file at index [param idx].
			</description>
		</method>
		<method name="get_file_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of files in this directory.
			</description>
		</method>
		<method name="get_file_import_is_valid" qualifiers="const">
			<return type="bool" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns [code]true[/code] if the file at index [param idx] imported properly.
			</description>
		</method>
		<method name="get_file_path" qualifiers="const">
			<return type="String" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the path to the file at index [param idx].
			</description>
		</method>
		<method name="get_file_script_class_extends" qualifiers="const">
			<return type="String" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the base class of the script class defined in the file at index [param idx]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
			</description>
		</method>
		<method name="get_file_script_class_name" qualifiers="const">
			<return type="String" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the name of the script class defined in the file at index [param idx]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
			</description>
		</method>
		<method name="get_file_type" qualifiers="const">
			<return type="StringName" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the resource type of the file at index [param idx]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code].
			</description>
		</method>
		<method name="get_name">
			<return type="String" />
			<description>
				Returns the name of this directory.
			</description>
		</method>
		<method name="get_parent">
			<return type="EditorFileSystemDirectory" />
			<description>
				Returns the parent directory for this directory or [code]null[/code] if called on a directory at [code]res://[/code] or [code]user://[/code].
			</description>
		</method>
		<method name="get_path" qualifiers="const">
			<return type="String" />
			<description>
				Returns the path to this directory.
			</description>
		</method>
		<method name="get_subdir">
			<return type="EditorFileSystemDirectory" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the subdirectory at index [param idx].
			</description>
		</method>
		<method name="get_subdir_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of subdirectories in this directory.
			</description>
		</method>
	</methods>
</class>