Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_editorfilesystemdirectory.rst

class_editorfilesystemdirectory.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileSystemDirectory.xml.
    7. 

  7. 

  8. .. _class_EditorFileSystemDirectory:
    9. 

  9. 

  10. EditorFileSystemDirectory
    11. 

  11. =========================
    12. 

  12. 

  13. **Inherits:** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A directory for the resource filesystem.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. A more generalized, low-level variation of the directory concept.
    21. 

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`int<class_int>`                                             | :ref:`find_dir_index<class_EditorFileSystemDirectory_method_find_dir_index>` **(** :ref:`String<class_String>` name **)** |const|                        |
    27. 

  27. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`int<class_int>`                                             | :ref:`find_file_index<class_EditorFileSystemDirectory_method_find_file_index>` **(** :ref:`String<class_String>` name **)** |const|                      |
    29. 

  29. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`String<class_String>`                                       | :ref:`get_file<class_EditorFileSystemDirectory_method_get_file>` **(** :ref:`int<class_int>` idx **)** |const|                                           |
    31. 

  31. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`                                             | :ref:`get_file_count<class_EditorFileSystemDirectory_method_get_file_count>` **(** **)** |const|                                                         |
    33. 

  33. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`bool<class_bool>`                                           | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_method_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** |const|           |
    35. 

  35. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`String<class_String>`                                       | :ref:`get_file_path<class_EditorFileSystemDirectory_method_get_file_path>` **(** :ref:`int<class_int>` idx **)** |const|                                 |
    37. 

  37. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`String<class_String>`                                       | :ref:`get_file_script_class_extends<class_EditorFileSystemDirectory_method_get_file_script_class_extends>` **(** :ref:`int<class_int>` idx **)** |const| |
    39. 

  39. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`String<class_String>`                                       | :ref:`get_file_script_class_name<class_EditorFileSystemDirectory_method_get_file_script_class_name>` **(** :ref:`int<class_int>` idx **)** |const|       |
    41. 

  41. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`StringName<class_StringName>`                               | :ref:`get_file_type<class_EditorFileSystemDirectory_method_get_file_type>` **(** :ref:`int<class_int>` idx **)** |const|                                 |
    43. 

  43. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`String<class_String>`                                       | :ref:`get_name<class_EditorFileSystemDirectory_method_get_name>` **(** **)**                                                                             |
    45. 

  45. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_method_get_parent>` **(** **)**                                                                         |
    47. 

  47. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`String<class_String>`                                       | :ref:`get_path<class_EditorFileSystemDirectory_method_get_path>` **(** **)** |const|                                                                     |
    49. 

  49. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_method_get_subdir>` **(** :ref:`int<class_int>` idx **)**                                               |
    51. 

  51. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`                                             | :ref:`get_subdir_count<class_EditorFileSystemDirectory_method_get_subdir_count>` **(** **)** |const|                                                     |
    53. 

  53. +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. 

  55. Method Descriptions
    56. 

  56. -------------------
    57. 

  57. 

  58. .. _class_EditorFileSystemDirectory_method_find_dir_index:
    59. 

  59. 

  60. - :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_String>` name **)** |const|
    61. 

  61. 

  62. Returns the index of the directory with name ``name`` or ``-1`` if not found.
    63. 

  63. 

  64. ----
    65. 

  65. 

  66. .. _class_EditorFileSystemDirectory_method_find_file_index:
    67. 

  67. 

  68. - :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_String>` name **)** |const|
    69. 

  69. 

  70. Returns the index of the file with name ``name`` or ``-1`` if not found.
    71. 

  71. 

  72. ----
    73. 

  73. 

  74. .. _class_EditorFileSystemDirectory_method_get_file:
    75. 

  75. 

  76. - :ref:`String<class_String>` **get_file** **(** :ref:`int<class_int>` idx **)** |const|
    77. 

  77. 

  78. Returns the name of the file at index ``idx``.
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_EditorFileSystemDirectory_method_get_file_count:
    83. 

  83. 

  84. - :ref:`int<class_int>` **get_file_count** **(** **)** |const|
    85. 

  85. 

  86. Returns the number of files in this directory.
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_EditorFileSystemDirectory_method_get_file_import_is_valid:
    91. 

  91. 

  92. - :ref:`bool<class_bool>` **get_file_import_is_valid** **(** :ref:`int<class_int>` idx **)** |const|
    93. 

  93. 

  94. Returns ``true`` if the file at index ``idx`` imported properly.
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_EditorFileSystemDirectory_method_get_file_path:
    99. 

  99. 

  100. - :ref:`String<class_String>` **get_file_path** **(** :ref:`int<class_int>` idx **)** |const|
    101. 

  101. 

  102. Returns the path to the file at index ``idx``.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_EditorFileSystemDirectory_method_get_file_script_class_extends:
    107. 

  107. 

  108. - :ref:`String<class_String>` **get_file_script_class_extends** **(** :ref:`int<class_int>` idx **)** |const|
    109. 

  109. 

  110. 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.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_EditorFileSystemDirectory_method_get_file_script_class_name:
    115. 

  115. 

  116. - :ref:`String<class_String>` **get_file_script_class_name** **(** :ref:`int<class_int>` idx **)** |const|
    117. 

  117. 

  118. 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.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_EditorFileSystemDirectory_method_get_file_type:
    123. 

  123. 

  124. - :ref:`StringName<class_StringName>` **get_file_type** **(** :ref:`int<class_int>` idx **)** |const|
    125. 

  125. 

  126. 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"``.
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_EditorFileSystemDirectory_method_get_name:
    131. 

  131. 

  132. - :ref:`String<class_String>` **get_name** **(** **)**
    133. 

  133. 

  134. Returns the name of this directory.
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_EditorFileSystemDirectory_method_get_parent:
    139. 

  139. 

  140. - :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_parent** **(** **)**
    141. 

  141. 

  142. Returns the parent directory for this directory or ``null`` if called on a directory at ``res://`` or ``user://``.
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_EditorFileSystemDirectory_method_get_path:
    147. 

  147. 

  148. - :ref:`String<class_String>` **get_path** **(** **)** |const|
    149. 

  149. 

  150. Returns the path to this directory.
    151. 

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_EditorFileSystemDirectory_method_get_subdir:
    155. 

  155. 

  156. - :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
    157. 

  157. 

  158. Returns the subdirectory at index ``idx``.
    159. 

  159. 

  160. ----
    161. 

  161. 

  162. .. _class_EditorFileSystemDirectory_method_get_subdir_count:
    163. 

  163. 

  164. - :ref:`int<class_int>` **get_subdir_count** **(** **)** |const|
    165. 

  165. 

  166. Returns the number of subdirectories in this directory.
    167. 

  167. 

  168. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    169. 

  169. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    170. 

  170. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    171. 

  171. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    172. 

  172. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    173. 

  173. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    174.