:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileSystemDock.xml. .. _class_FileSystemDock: FileSystemDock ============== **Inherits:** :ref:`VBoxContainer` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Godot editor's dock for managing files in the project. .. rst-class:: classref-introduction-group Description ----------- This class is available only in :ref:`EditorPlugin`\ s and can't be instantiated. You can access it using :ref:`EditorInterface.get_file_system_dock()`. While **FileSystemDock** doesn't expose any methods for file manipulation, it can listen for various file-related signals. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_resource_tooltip_plugin`\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) | +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`navigate_to_path`\ (\ path\: :ref:`String`\ ) | +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_resource_tooltip_plugin`\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) | +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_FileSystemDock_signal_display_mode_changed: .. rst-class:: classref-signal **display_mode_changed**\ (\ ) :ref:`🔗` Emitted when the user switches file display mode or split mode. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_file_removed: .. rst-class:: classref-signal **file_removed**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Emitted when the given ``file`` was removed. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_files_moved: .. rst-class:: classref-signal **files_moved**\ (\ old_file\: :ref:`String`, new_file\: :ref:`String`\ ) :ref:`🔗` Emitted when a file is moved from ``old_file`` path to ``new_file`` path. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_folder_color_changed: .. rst-class:: classref-signal **folder_color_changed**\ (\ ) :ref:`🔗` Emitted when folders change color. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_folder_moved: .. rst-class:: classref-signal **folder_moved**\ (\ old_folder\: :ref:`String`, new_folder\: :ref:`String`\ ) :ref:`🔗` Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_folder_removed: .. rst-class:: classref-signal **folder_removed**\ (\ folder\: :ref:`String`\ ) :ref:`🔗` Emitted when the given ``folder`` was removed. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_inherit: .. rst-class:: classref-signal **inherit**\ (\ file\: :ref:`String`\ ) :ref:`🔗` Emitted when a new scene is created that inherits the scene at ``file`` path. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_instantiate: .. rst-class:: classref-signal **instantiate**\ (\ files\: :ref:`PackedStringArray`\ ) :ref:`🔗` Emitted when the given scenes are being instantiated in the editor. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_signal_resource_removed: .. rst-class:: classref-signal **resource_removed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Emitted when an external ``resource`` had its file removed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_FileSystemDock_method_add_resource_tooltip_plugin: .. rst-class:: classref-method |void| **add_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) :ref:`🔗` Registers a new :ref:`EditorResourceTooltipPlugin`. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_method_navigate_to_path: .. rst-class:: classref-method |void| **navigate_to_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Sets the given ``path`` as currently selected, ensuring that the selected file/directory is visible. .. rst-class:: classref-item-separator ---- .. _class_FileSystemDock_method_remove_resource_tooltip_plugin: .. rst-class:: classref-method |void| **remove_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) :ref:`🔗` Removes an :ref:`EditorResourceTooltipPlugin`. Fails if the plugin wasn't previously added. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`