Table of Contents

Class FileSystemDock

Namespace
Godot
Assembly
GodotSharpEditor.dll

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

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

public class FileSystemDock : VBoxContainer, IDisposable
Inheritance
FileSystemDock
Implements
Inherited Members

Methods

AddResourceTooltipPlugin(EditorResourceTooltipPlugin)

Registers a new EditorResourceTooltipPlugin.

public void AddResourceTooltipPlugin(EditorResourceTooltipPlugin plugin)

Parameters

plugin EditorResourceTooltipPlugin

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

NavigateToPath(string)

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

public void NavigateToPath(string path)

Parameters

path string

RemoveResourceTooltipPlugin(EditorResourceTooltipPlugin)

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

public void RemoveResourceTooltipPlugin(EditorResourceTooltipPlugin plugin)

Parameters

plugin EditorResourceTooltipPlugin

Events

DisplayModeChanged

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

public event Action DisplayModeChanged

Event Type

Action

FileRemoved

Emitted when the given file was removed.

public event FileSystemDock.FileRemovedEventHandler FileRemoved

Event Type

FileSystemDock.FileRemovedEventHandler

FilesMoved

Emitted when a file is moved from oldFile path to newFile path.

public event FileSystemDock.FilesMovedEventHandler FilesMoved

Event Type

FileSystemDock.FilesMovedEventHandler

FolderMoved

Emitted when a folder is moved from oldFolder path to newFolder path.

public event FileSystemDock.FolderMovedEventHandler FolderMoved

Event Type

FileSystemDock.FolderMovedEventHandler

FolderRemoved

Emitted when the given folder was removed.

public event FileSystemDock.FolderRemovedEventHandler FolderRemoved

Event Type

FileSystemDock.FolderRemovedEventHandler

Inherit

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

public event FileSystemDock.InheritEventHandler Inherit

Event Type

FileSystemDock.InheritEventHandler

Instantiate

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

public event FileSystemDock.InstantiateEventHandler Instantiate

Event Type

FileSystemDock.InstantiateEventHandler

ResourceRemoved

Emitted when an external resource had its file removed.

public event FileSystemDock.ResourceRemovedEventHandler ResourceRemoved

Event Type

FileSystemDock.ResourceRemovedEventHandler
Edit this page