diff options
Diffstat (limited to 'doc/classes/FileSystemDock.xml')
| -rw-r--r-- | doc/classes/FileSystemDock.xml | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index f76bc2c279..f549695e72 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="FileSystemDock" inherits="VBoxContainer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Editor dock for managing files in the project. </brief_description> <description> + This class is available only in [EditorPlugin]s and can't be instantiated. You can access it using [method EditorInterface.get_file_system_dock]. + While FileSystemDock doesn't expose any methods for file manipulation, you can listen for various file-related signals. </description> <tutorials> </tutorials> @@ -11,49 +14,58 @@ <return type="void" /> <param index="0" name="path" type="String" /> <description> + Sets the given [param path] as currently selected, ensuring that the selected file/directory is visible. </description> </method> </methods> <signals> <signal name="display_mode_changed"> <description> + Emitted when the user switches file display mode or split mode. </description> </signal> <signal name="file_removed"> <param index="0" name="file" type="String" /> <description> + Emitted when the given [param file] was removed. </description> </signal> <signal name="files_moved"> <param index="0" name="old_file" type="String" /> <param index="1" name="new_file" type="String" /> <description> + Emitted when a file is moved from [param old_file] path to [param new_file] path. </description> </signal> <signal name="folder_moved"> <param index="0" name="old_folder" type="String" /> <param index="1" name="new_folder" type="String" /> <description> + Emitted when a folder is moved from [param old_folder] path to [param new_folder] path. </description> </signal> <signal name="folder_removed"> <param index="0" name="folder" type="String" /> <description> + Emitted when the given [param folder] was removed. </description> </signal> <signal name="inherit"> <param index="0" name="file" type="String" /> <description> + Emitted when a new scene is created that inherits the scene at [param file] path. </description> </signal> <signal name="instantiate"> <param index="0" name="files" type="PackedStringArray" /> <description> + Emitted when the given scenes are being instantiated in the editor. </description> </signal> <signal name="resource_removed"> <param index="0" name="resource" type="Resource" /> <description> + Emitted when an external [param resource] had its file removed. </description> </signal> </signals> |