pandemonium_engine/doc/classes/EditorFileSystemDirectory.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFileSystemDirectory" inherits="Object" version="4.4">
	<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" />
			<argument index="0" name="name" type="String" />
			<description>
				Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
			</description>
		</method>
		<method name="find_file_index" qualifiers="const">
			<return type="int" />
			<argument index="0" name="name" type="String" />
			<description>
				Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
			</description>
		</method>
		<method name="get_file" qualifiers="const">
			<return type="String" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the name of the file at index [code]idx[/code].
			</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" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
			</description>
		</method>
		<method name="get_file_path" qualifiers="const">
			<return type="String" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the path to the file at index [code]idx[/code].
			</description>
		</method>
		<method name="get_file_script_class_extends" qualifiers="const">
			<return type="String" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the base class of the script class defined in the file at index [code]idx[/code]. 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" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the name of the script class defined in the file at index [code]idx[/code]. 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" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the resource type of the file at index [code]idx[/code]. 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" />
			<argument index="0" name="idx" type="int" />
			<description>
				Returns the subdirectory at index [code]idx[/code].
			</description>
		</method>
		<method name="get_subdir_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of subdirectories in this directory.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>