EditorFileSystem.xml 2.9 KB

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