EditorFileSystemDirectory.xml 3.7 KB

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