EditorFileSystem.xml 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EditorFileSystem" inherits="Node" category="Core" version="3.0.alpha.custom_build">
  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. </description>
  37. </method>
  38. <method name="get_scanning_progress" qualifiers="const">
  39. <return type="float">
  40. </return>
  41. <description>
  42. Return the scan progress for 0 to 1 if the FS is being scanned.
  43. </description>
  44. </method>
  45. <method name="is_scanning" qualifiers="const">
  46. <return type="bool">
  47. </return>
  48. <description>
  49. Return true of the filesystem is being scanned.
  50. </description>
  51. </method>
  52. <method name="scan">
  53. <return type="void">
  54. </return>
  55. <description>
  56. Scan the filesystem for changes.
  57. </description>
  58. </method>
  59. <method name="scan_sources">
  60. <return type="void">
  61. </return>
  62. <description>
  63. Check if the source of any imported resource changed.
  64. </description>
  65. </method>
  66. <method name="update_file">
  67. <return type="void">
  68. </return>
  69. <argument index="0" name="path" type="String">
  70. </argument>
  71. <description>
  72. Update a file information. Call this if an external program (not Godot) modified the file.
  73. </description>
  74. </method>
  75. </methods>
  76. <signals>
  77. <signal name="filesystem_changed">
  78. <description>
  79. Emitted if the filesystem changed.
  80. </description>
  81. </signal>
  82. <signal name="resources_reimported">
  83. <argument index="0" name="resources" type="PoolStringArray">
  84. </argument>
  85. <description>
  86. </description>
  87. </signal>
  88. <signal name="sources_changed">
  89. <argument index="0" name="exist" type="bool">
  90. </argument>
  91. <description>
  92. Emitted if the source of any imported file changed.
  93. </description>
  94. </signal>
  95. </signals>
  96. <constants>
  97. </constants>
  98. </class>