239 lines
12 KiB
Text
239 lines
12 KiB
Text
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorFileSystemDirectory.xml.
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory:
|
||
|
|
|
||
|
|
EditorFileSystemDirectory
|
||
|
|
=========================
|
||
|
|
|
||
|
|
**Inherits:** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
A directory for the resource filesystem.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
A more generalized, low-level variation of the directory concept.
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Methods
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_method_find_dir_index>` **(** :ref:`String<class_String>` name **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_method_find_file_index>` **(** :ref:`String<class_String>` name **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_file<class_EditorFileSystemDirectory_method_get_file>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_method_get_file_count>` **(** **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_method_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_file_path<class_EditorFileSystemDirectory_method_get_file_path>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_file_script_class_extends<class_EditorFileSystemDirectory_method_get_file_script_class_extends>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_file_script_class_name<class_EditorFileSystemDirectory_method_get_file_script_class_name>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_file_type<class_EditorFileSystemDirectory_method_get_file_type>` **(** :ref:`int<class_int>` idx **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_name<class_EditorFileSystemDirectory_method_get_name>` **(** **)** |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_method_get_parent>` **(** **)** |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`get_path<class_EditorFileSystemDirectory_method_get_path>` **(** **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_method_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_method_get_subdir_count>` **(** **)** |const| |
|
||
|
|
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_find_dir_index:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
: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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_find_file_index:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
: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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_file** **(** :ref:`int<class_int>` idx **)** |const|
|
||
|
|
|
||
|
|
Returns the name of the file at index ``idx``.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_count:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`int<class_int>` **get_file_count** **(** **)** |const|
|
||
|
|
|
||
|
|
Returns the number of files in this directory.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_import_is_valid:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
: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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_path:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_file_path** **(** :ref:`int<class_int>` idx **)** |const|
|
||
|
|
|
||
|
|
Returns the path to the file at index ``idx``.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_script_class_extends:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_file_script_class_extends** **(** :ref:`int<class_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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_script_class_name:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_file_script_class_name** **(** :ref:`int<class_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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_file_type:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_file_type** **(** :ref:`int<class_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"``.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_name:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_name** **(** **)**
|
||
|
|
|
||
|
|
Returns the name of this directory.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_parent:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_parent** **(** **)**
|
||
|
|
|
||
|
|
Returns the parent directory for this directory or ``null`` if called on a directory at ``res://`` or ``user://``.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_path:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`String<class_String>` **get_path** **(** **)** |const|
|
||
|
|
|
||
|
|
Returns the path to this directory.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_subdir:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
||
|
|
|
||
|
|
Returns the subdirectory at index ``idx``.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_EditorFileSystemDirectory_method_get_subdir_count:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
:ref:`int<class_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.)`
|
||
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|