ContentBrowser — C# API

class ContentBrowserReckfellSharpEditorInherits EditorDock

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

This class is available only in EditorPlugins and can't be instantiated. You can access it using EditorInterface.GetContentBrowser. While ContentBrowser doesn't expose any methods for file manipulation, it can listen for various file-related signals.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods4

AddResourceTooltipPluginvoid

# AddResourceTooltipPlugin

C#
public void AddResourceTooltipPlugin(EditorResourceTooltipPlugin plugin);

Registers a new EditorResourceTooltipPlugin.

Parameters
Name	Type	Default
`plugin`	`EditorResourceTooltipPlugin`	—

ChangeTreeRoleError

# ChangeTreeRole

C#
public Error ChangeTreeRole(string path, bool isScene);

Parameters
Name	Type	Default
`path`	`string`	—
`isScene`	`bool`	—

Returns Error

NavigateToPathvoid

# NavigateToPath

C#
public void NavigateToPath(string path);

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

Parameters
Name	Type	Default
`path`	`string`	—

RemoveResourceTooltipPluginvoid

# RemoveResourceTooltipPlugin

C#
public void RemoveResourceTooltipPlugin(EditorResourceTooltipPlugin plugin);

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

Parameters
Name	Type	Default
`plugin`	`EditorResourceTooltipPlugin`	—

Signals and events10

DisplayModeChangedEvent

# DisplayModeChanged

public event Action DisplayModeChanged;

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

FileRemovedEvent

# FileRemoved

public event ContentBrowser.FileRemovedEventHandler FileRemoved;

Emitted when the given file was removed.

Handler parameters
Name	Type	Default
`file`	`string`	—

FilesMovedEvent

# FilesMoved

public event ContentBrowser.FilesMovedEventHandler FilesMoved;

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

Handler parameters
Name	Type	Default
`oldFile`	`string`	—
`newFile`	`string`	—

FolderColorChangedEvent

# FolderColorChanged

public event Action FolderColorChanged;

Emitted when folders change color.

FolderMovedEvent

# FolderMoved

public event ContentBrowser.FolderMovedEventHandler FolderMoved;

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

Handler parameters
Name	Type	Default
`oldFolder`	`string`	—
`newFolder`	`string`	—

FolderRemovedEvent

# FolderRemoved

public event ContentBrowser.FolderRemovedEventHandler FolderRemoved;

Emitted when the given folder was removed.

Handler parameters
Name	Type	Default
`folder`	`string`	—

InheritEvent

# Inherit

public event ContentBrowser.InheritEventHandler Inherit;

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

Handler parameters
Name	Type	Default
`file`	`string`	—

InstantiateEvent

# Instantiate

public event ContentBrowser.InstantiateEventHandler Instantiate;

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

Handler parameters
Name	Type	Default
`files`	`string[]`	—

ResourceRemovedEvent

# ResourceRemoved

public event ContentBrowser.ResourceRemovedEventHandler ResourceRemoved;

Emitted when an external resource had its file removed.

Handler parameters
Name	Type	Default
`resource`	`Resource`	—

SelectionChangedEvent

# SelectionChanged

public event Action SelectionChanged;

Emitted when the selection changes. Use EditorInterface.GetSelectedPaths in the connected method to get the selected paths.