2020-03-20 11:58:38 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2022-02-14 13:18:53 +00:00
|
|
|
<class name="FileSystemDock" inherits="VBoxContainer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
2020-03-20 11:58:38 +00:00
|
|
|
<brief_description>
|
2023-04-30 14:26:09 +00:00
|
|
|
Godot editor's dock for managing files in the project.
|
2020-03-20 11:58:38 +00:00
|
|
|
</brief_description>
|
|
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
This class is available only in [EditorPlugin]s and can't be instantiated. You can access it using [method EditorInterface.get_file_system_dock].
|
2023-04-30 14:26:09 +00:00
|
|
|
While [FileSystemDock] doesn't expose any methods for file manipulation, it can listen for various file-related signals.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
<tutorials>
|
|
|
|
|
</tutorials>
|
|
|
|
|
<methods>
|
|
|
|
|
<method name="navigate_to_path">
|
2021-07-30 13:28:05 +00:00
|
|
|
<return type="void" />
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="path" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Sets the given [param path] as currently selected, ensuring that the selected file/directory is visible.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</method>
|
|
|
|
|
</methods>
|
|
|
|
|
<signals>
|
|
|
|
|
<signal name="display_mode_changed">
|
|
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when the user switches file display mode or split mode.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
|
|
|
|
<signal name="file_removed">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="file" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when the given [param file] was removed.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
|
|
|
|
<signal name="files_moved">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="old_file" type="String" />
|
|
|
|
|
<param index="1" name="new_file" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when a file is moved from [param old_file] path to [param new_file] path.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
|
|
|
|
<signal name="folder_moved">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="old_folder" type="String" />
|
2022-10-07 16:38:29 +00:00
|
|
|
<param index="1" name="new_folder" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when a folder is moved from [param old_folder] path to [param new_folder] path.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
|
|
|
|
<signal name="folder_removed">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="folder" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when the given [param folder] was removed.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
|
|
|
|
<signal name="inherit">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="file" type="String" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when a new scene is created that inherits the scene at [param file] path.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
2022-11-15 23:13:39 +00:00
|
|
|
<signal name="instantiate">
|
2022-08-06 18:11:48 +00:00
|
|
|
<param index="0" name="files" type="PackedStringArray" />
|
2020-03-20 11:58:38 +00:00
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when the given scenes are being instantiated in the editor.
|
2020-03-20 11:58:38 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
2023-01-23 09:01:28 +00:00
|
|
|
<signal name="resource_removed">
|
|
|
|
|
<param index="0" name="resource" type="Resource" />
|
|
|
|
|
<description>
|
2023-02-28 14:06:21 +00:00
|
|
|
Emitted when an external [param resource] had its file removed.
|
2023-01-23 09:01:28 +00:00
|
|
|
</description>
|
|
|
|
|
</signal>
|
2020-03-20 11:58:38 +00:00
|
|
|
</signals>
|
|
|
|
|
</class>
|
