Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

FileSystemDock

Inherits: VBoxContainer < BoxContainer < Container < Control < CanvasItem < Node < Object

Godot editor's dock for managing files in the project.

Description

This class is available only in EditorPlugins and can't be instantiated. You can access it using EditorInterface.get_file_system_dock.

While FileSystemDock doesn't expose any methods for file manipulation, it can listen for various file-related signals.

Methods

void

add_resource_tooltip_plugin ( EditorResourceTooltipPlugin plugin )

void

navigate_to_path ( String path )

void

remove_resource_tooltip_plugin ( EditorResourceTooltipPlugin plugin )


Signals

display_mode_changed ( )

Emitted when the user switches file display mode or split mode.


file_removed ( String file )

Emitted when the given file was removed.


files_moved ( String old_file, String new_file )

Emitted when a file is moved from old_file path to new_file path.


folder_moved ( String old_folder, String new_folder )

Emitted when a folder is moved from old_folder path to new_folder path.


folder_removed ( String folder )

Emitted when the given folder was removed.


inherit ( String file )

Emitted when a new scene is created that inherits the scene at file path.


instantiate ( PackedStringArray files )

Emitted when the given scenes are being instantiated in the editor.


resource_removed ( Resource resource )

Emitted when an external resource had its file removed.


Method Descriptions

void add_resource_tooltip_plugin ( EditorResourceTooltipPlugin plugin )

Registers a new EditorResourceTooltipPlugin.


void navigate_to_path ( String path )

Sets the given path as currently selected, ensuring that the selected file/directory is visible.


void remove_resource_tooltip_plugin ( EditorResourceTooltipPlugin plugin )

Removes an EditorResourceTooltipPlugin. Fails if the plugin wasn't previously added.