EditorFileSystem.xml 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EditorFileSystem" inherits="Node" category="Core" version="3.1">
  3. <brief_description>
  4. Resource filesystem, as the editor sees it.
  5. </brief_description>
  6. <description>
  7. This object holds information of all resources in the filesystem, their types, etc.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_file_type" qualifiers="const">
  15. <return type="String">
  16. </return>
  17. <argument index="0" name="path" type="String">
  18. </argument>
  19. <description>
  20. Get the type of the file, given the full path.
  21. </description>
  22. </method>
  23. <method name="get_filesystem">
  24. <return type="EditorFileSystemDirectory">
  25. </return>
  26. <description>
  27. Get the root directory object.
  28. </description>
  29. </method>
  30. <method name="get_filesystem_path">
  31. <return type="EditorFileSystemDirectory">
  32. </return>
  33. <argument index="0" name="path" type="String">
  34. </argument>
  35. <description>
  36. Returns a view into the filesystem at [code]path[/code].
  37. </description>
  38. </method>
  39. <method name="get_scanning_progress" qualifiers="const">
  40. <return type="float">
  41. </return>
  42. <description>
  43. Return the scan progress for 0 to 1 if the FS is being scanned.
  44. </description>
  45. </method>
  46. <method name="is_scanning" qualifiers="const">
  47. <return type="bool">
  48. </return>
  49. <description>
  50. Return true of the filesystem is being scanned.
  51. </description>
  52. </method>
  53. <method name="scan">
  54. <return type="void">
  55. </return>
  56. <description>
  57. Scan the filesystem for changes.
  58. </description>
  59. </method>
  60. <method name="scan_sources">
  61. <return type="void">
  62. </return>
  63. <description>
  64. Check if the source of any imported resource changed.
  65. </description>
  66. </method>
  67. <method name="update_file">
  68. <return type="void">
  69. </return>
  70. <argument index="0" name="path" type="String">
  71. </argument>
  72. <description>
  73. Update a file information. Call this if an external program (not Godot) modified the file.
  74. </description>
  75. </method>
  76. <method name="update_script_classes">
  77. <return type="void">
  78. </return>
  79. <description>
  80. </description>
  81. </method>
  82. </methods>
  83. <signals>
  84. <signal name="filesystem_changed">
  85. <description>
  86. Emitted if the filesystem changed.
  87. </description>
  88. </signal>
  89. <signal name="resources_reimported">
  90. <argument index="0" name="resources" type="PoolStringArray">
  91. </argument>
  92. <description>
  93. Remitted if a resource is reimported.
  94. </description>
  95. </signal>
  96. <signal name="resources_reload">
  97. <argument index="0" name="resources" type="PoolStringArray">
  98. </argument>
  99. <description>
  100. </description>
  101. </signal>
  102. <signal name="sources_changed">
  103. <argument index="0" name="exist" type="bool">
  104. </argument>
  105. <description>
  106. Emitted if the source of any imported file changed.
  107. </description>
  108. </signal>
  109. </signals>
  110. <constants>
  111. </constants>
  112. </class>