123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the EditorFileSystemDirectory.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_EditorFileSystemDirectory:
- EditorFileSystemDirectory
- =========================
- **Inherits:** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- A diretory for the resource filesystem.
- Member Functions
- ----------------
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- Description
- -----------
- A more generalized, low-level variation of the directory concept.
- Member Function Description
- ---------------------------
- .. _class_EditorFileSystemDirectory_find_dir_index:
- - :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
- Returns the index of the directory with name ``name`` or ``-1`` if not found.
- .. _class_EditorFileSystemDirectory_find_file_index:
- - :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
- Returns the index of the file with name ``name`` or ``-1`` if not found.
- .. _class_EditorFileSystemDirectory_get_file:
- - :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
- Returns the name of the file at index ``idx``.
- .. _class_EditorFileSystemDirectory_get_file_count:
- - :ref:`int<class_int>` **get_file_count** **(** **)** const
- Returns the number of files in this directory.
- .. _class_EditorFileSystemDirectory_get_file_import_is_valid:
- - :ref:`bool<class_bool>` **get_file_import_is_valid** **(** :ref:`int<class_int>` idx **)** const
- Returns ``true`` if the file at index ``idx`` imported properly.
- .. _class_EditorFileSystemDirectory_get_file_path:
- - :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
- Returns the path to the file at index ``idx``.
- .. _class_EditorFileSystemDirectory_get_file_type:
- - :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
- Returns the file extension of the file at index ``idx``.
- .. _class_EditorFileSystemDirectory_get_name:
- - :ref:`String<class_string>` **get_name** **(** **)**
- Returns the name of this directory.
- .. _class_EditorFileSystemDirectory_get_parent:
- - :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
- Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``.
- .. _class_EditorFileSystemDirectory_get_path:
- - :ref:`String<class_string>` **get_path** **(** **)** const
- Returns the path to this directory.
- .. _class_EditorFileSystemDirectory_get_subdir:
- - :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
- Returns the subdirectory at index ``idx``.
- .. _class_EditorFileSystemDirectory_get_subdir_count:
- - :ref:`int<class_int>` **get_subdir_count** **(** **)** const
- Returns the number of subdirectories in this directory.
|