godot/doc/classes/FileSystemDock.xml
Rémi Verschelde 81064cc239
Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00

87 lines
3.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="FileSystemDock" inherits="VBoxContainer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Godot editor's 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, it can listen for various file-related signals.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_resource_tooltip_plugin">
<return type="void" />
<param index="0" name="plugin" type="EditorResourceTooltipPlugin" />
<description>
Registers a new [EditorResourceTooltipPlugin].
</description>
</method>
<method name="navigate_to_path">
<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>
<method name="remove_resource_tooltip_plugin">
<return type="void" />
<param index="0" name="plugin" type="EditorResourceTooltipPlugin" />
<description>
Removes an [EditorResourceTooltipPlugin]. Fails if the plugin wasn't previously added.
</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>
</class>