EditorFileSystemDirectory.xml 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.1.2">
  3. <brief_description>
  4. A directory for the resource filesystem.
  5. </brief_description>
  6. <description>
  7. A more generalized, low-level variation of the directory concept.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="find_dir_index" qualifiers="const">
  13. <return type="int">
  14. </return>
  15. <argument index="0" name="name" type="String">
  16. </argument>
  17. <description>
  18. Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
  19. </description>
  20. </method>
  21. <method name="find_file_index" qualifiers="const">
  22. <return type="int">
  23. </return>
  24. <argument index="0" name="name" type="String">
  25. </argument>
  26. <description>
  27. Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
  28. </description>
  29. </method>
  30. <method name="get_file" qualifiers="const">
  31. <return type="String">
  32. </return>
  33. <argument index="0" name="idx" type="int">
  34. </argument>
  35. <description>
  36. Returns the name of the file at index [code]idx[/code].
  37. </description>
  38. </method>
  39. <method name="get_file_count" qualifiers="const">
  40. <return type="int">
  41. </return>
  42. <description>
  43. Returns the number of files in this directory.
  44. </description>
  45. </method>
  46. <method name="get_file_import_is_valid" qualifiers="const">
  47. <return type="bool">
  48. </return>
  49. <argument index="0" name="idx" type="int">
  50. </argument>
  51. <description>
  52. Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
  53. </description>
  54. </method>
  55. <method name="get_file_path" qualifiers="const">
  56. <return type="String">
  57. </return>
  58. <argument index="0" name="idx" type="int">
  59. </argument>
  60. <description>
  61. Returns the path to the file at index [code]idx[/code].
  62. </description>
  63. </method>
  64. <method name="get_file_script_class_extends" qualifiers="const">
  65. <return type="String">
  66. </return>
  67. <argument index="0" name="idx" type="int">
  68. </argument>
  69. <description>
  70. </description>
  71. </method>
  72. <method name="get_file_script_class_name" qualifiers="const">
  73. <return type="String">
  74. </return>
  75. <argument index="0" name="idx" type="int">
  76. </argument>
  77. <description>
  78. </description>
  79. </method>
  80. <method name="get_file_type" qualifiers="const">
  81. <return type="String">
  82. </return>
  83. <argument index="0" name="idx" type="int">
  84. </argument>
  85. <description>
  86. Returns the file extension of the file at index [code]idx[/code].
  87. </description>
  88. </method>
  89. <method name="get_name">
  90. <return type="String">
  91. </return>
  92. <description>
  93. Returns the name of this directory.
  94. </description>
  95. </method>
  96. <method name="get_parent">
  97. <return type="EditorFileSystemDirectory">
  98. </return>
  99. <description>
  100. Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code].
  101. </description>
  102. </method>
  103. <method name="get_path" qualifiers="const">
  104. <return type="String">
  105. </return>
  106. <description>
  107. Returns the path to this directory.
  108. </description>
  109. </method>
  110. <method name="get_subdir">
  111. <return type="EditorFileSystemDirectory">
  112. </return>
  113. <argument index="0" name="idx" type="int">
  114. </argument>
  115. <description>
  116. Returns the subdirectory at index [code]idx[/code].
  117. </description>
  118. </method>
  119. <method name="get_subdir_count" qualifiers="const">
  120. <return type="int">
  121. </return>
  122. <description>
  123. Returns the number of subdirectories in this directory.
  124. </description>
  125. </method>
  126. </methods>
  127. <constants>
  128. </constants>
  129. </class>