Class FileSystemDock

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

Inheritance

VBoxContainer

BoxContainer

Container

Control

CanvasItem

Node

Object

FileSystemDock

Remarks

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

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

Methods

add_resource_tooltip_plugin(EditorResourceTooltipPlugin)

Registers a new EditorResourceTooltipPlugin.

void add_resource_tooltip_plugin(EditorResourceTooltipPlugin plugin)

Parameters

plugin EditorResourceTooltipPlugin

navigate_to_path(String)

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

void navigate_to_path(String path)

Parameters

path String

remove_resource_tooltip_plugin(EditorResourceTooltipPlugin)

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

void remove_resource_tooltip_plugin(EditorResourceTooltipPlugin plugin)

Parameters

plugin EditorResourceTooltipPlugin

Events

display_mode_changed

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

signal display_mode_changed

file_removed(String)

Emitted when the given file was removed.

signal file_removed(String file)

Parameters

file String

files_moved(String, String)

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

signal files_moved(String old_file, String new_file)

Parameters

old_file String

new_file String

folder_color_changed

Emitted when folders change color.

signal folder_color_changed

folder_moved(String, String)

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

signal folder_moved(String old_folder, String new_folder)

Parameters

old_folder String

new_folder String

folder_removed(String)

Emitted when the given folder was removed.

signal folder_removed(String folder)

Parameters

folder String

inherit(String)

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

signal inherit(String file)

Parameters

file String

instantiate(PackedStringArray)

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

signal instantiate(PackedStringArray files)

Parameters

files PackedStringArray

resource_removed(Resource)

Emitted when an external resource had its file removed.

signal resource_removed(Resource resource)

Parameters

resource Resource