class_editorfilesystemdirectory.rst 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the EditorFileSystemDirectory.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_EditorFileSystemDirectory:
  5. EditorFileSystemDirectory
  6. =========================
  7. **Inherits:** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A diretory for the resource filesystem.
  12. Member Functions
  13. ----------------
  14. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
  16. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
  18. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
  20. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
  22. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** const |
  24. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
  26. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
  28. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
  30. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
  32. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
  34. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
  36. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
  38. +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  39. Description
  40. -----------
  41. A more generalized, low-level variation of the directory concept.
  42. Member Function Description
  43. ---------------------------
  44. .. _class_EditorFileSystemDirectory_find_dir_index:
  45. - :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
  46. Returns the index of the directory with name ``name`` or ``-1`` if not found.
  47. .. _class_EditorFileSystemDirectory_find_file_index:
  48. - :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
  49. Returns the index of the file with name ``name`` or ``-1`` if not found.
  50. .. _class_EditorFileSystemDirectory_get_file:
  51. - :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
  52. Returns the name of the file at index ``idx``.
  53. .. _class_EditorFileSystemDirectory_get_file_count:
  54. - :ref:`int<class_int>` **get_file_count** **(** **)** const
  55. Returns the number of files in this directory.
  56. .. _class_EditorFileSystemDirectory_get_file_import_is_valid:
  57. - :ref:`bool<class_bool>` **get_file_import_is_valid** **(** :ref:`int<class_int>` idx **)** const
  58. Returns ``true`` if the file at index ``idx`` imported properly.
  59. .. _class_EditorFileSystemDirectory_get_file_path:
  60. - :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
  61. Returns the path to the file at index ``idx``.
  62. .. _class_EditorFileSystemDirectory_get_file_type:
  63. - :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
  64. Returns the file extension of the file at index ``idx``.
  65. .. _class_EditorFileSystemDirectory_get_name:
  66. - :ref:`String<class_string>` **get_name** **(** **)**
  67. Returns the name of this directory.
  68. .. _class_EditorFileSystemDirectory_get_parent:
  69. - :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
  70. Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``.
  71. .. _class_EditorFileSystemDirectory_get_path:
  72. - :ref:`String<class_string>` **get_path** **(** **)** const
  73. Returns the path to this directory.
  74. .. _class_EditorFileSystemDirectory_get_subdir:
  75. - :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
  76. Returns the subdirectory at index ``idx``.
  77. .. _class_EditorFileSystemDirectory_get_subdir_count:
  78. - :ref:`int<class_int>` **get_subdir_count** **(** **)** const
  79. Returns the number of subdirectories in this directory.