:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorFileSystemDirectory.xml. .. _class_EditorFileSystemDirectory: EditorFileSystemDirectory ========================= **Inherits:** :ref:`Object` A directory for the resource filesystem. Description ----------- A more generalized, low-level variation of the directory concept. Methods ------- +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_file_count` **(** **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_path` **(** **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_subdir_count` **(** **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorFileSystemDirectory_method_find_dir_index: - :ref:`int` **find_dir_index** **(** :ref:`String` name **)** |const| Returns the index of the directory with name ``name`` or ``-1`` if not found. ---- .. _class_EditorFileSystemDirectory_method_find_file_index: - :ref:`int` **find_file_index** **(** :ref:`String` name **)** |const| Returns the index of the file with name ``name`` or ``-1`` if not found. ---- .. _class_EditorFileSystemDirectory_method_get_file: - :ref:`String` **get_file** **(** :ref:`int` idx **)** |const| Returns the name of the file at index ``idx``. ---- .. _class_EditorFileSystemDirectory_method_get_file_count: - :ref:`int` **get_file_count** **(** **)** |const| Returns the number of files in this directory. ---- .. _class_EditorFileSystemDirectory_method_get_file_import_is_valid: - :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** |const| Returns ``true`` if the file at index ``idx`` imported properly. ---- .. _class_EditorFileSystemDirectory_method_get_file_path: - :ref:`String` **get_file_path** **(** :ref:`int` idx **)** |const| Returns the path to the file at index ``idx``. ---- .. _class_EditorFileSystemDirectory_method_get_file_script_class_extends: - :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** |const| Returns the base class of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. ---- .. _class_EditorFileSystemDirectory_method_get_file_script_class_name: - :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** |const| Returns the name of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. ---- .. _class_EditorFileSystemDirectory_method_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** |const| Returns the resource type of the file at index ``idx``. This returns a string such as ``"Resource"`` or ``"GDScript"``, *not* a file extension such as ``".gd"``. ---- .. _class_EditorFileSystemDirectory_method_get_name: - :ref:`String` **get_name** **(** **)** Returns the name of this directory. ---- .. _class_EditorFileSystemDirectory_method_get_parent: - :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** Returns the parent directory for this directory or ``null`` if called on a directory at ``res://`` or ``user://``. ---- .. _class_EditorFileSystemDirectory_method_get_path: - :ref:`String` **get_path** **(** **)** |const| Returns the path to this directory. ---- .. _class_EditorFileSystemDirectory_method_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. ---- .. _class_EditorFileSystemDirectory_method_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** |const| Returns the number of subdirectories in this directory. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`