EditorResourcePreview — C# API

class EditorResourcePreviewReckfellSharpEditorInherits Entity

A node used to generate previews of resources or files.

This node is used to generate previews for resources or files. Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.GetResourcePreviewer.

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

Methods5

AddPreviewGeneratorvoid

# AddPreviewGenerator

C#
public void AddPreviewGenerator(EditorResourcePreviewGenerator generator);

Create an own, custom preview generator.

Parameters
Name	Type	Default
`generator`	`EditorResourcePreviewGenerator`	—

CheckForInvalidationvoid

# CheckForInvalidation

C#
public void CheckForInvalidation(string path);

Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.

Parameters
Name	Type	Default
`path`	`string`	—

QueueEditedResourcePreviewvoid

# QueueEditedResourcePreview

C#
public void QueueEditedResourcePreview(Resource resource, ReckfellObject receiver, StringName receiverFunc, Variant userdata);

Queue the resource being edited for preview. Once the preview is ready, the receiver's receiver_func will be called. The receiver_func must take the following four arguments: string path, Texture2D preview, Texture2D thumbnail_preview, Variant userdata. userdata can be anything, and will be returned when receiver_func is called. Note: If it was not possible to create the preview the receiver_func will still be called, but the preview will be null.

Parameters
Name	Type	Default
`resource`	`Resource`	—
`receiver`	`ReckfellObject`	—
`receiverFunc`	`StringName`	—
`userdata`	`Variant`	—

QueueResourcePreviewvoid

# QueueResourcePreview

C#
public void QueueResourcePreview(string path, ReckfellObject receiver, StringName receiverFunc, Variant userdata);

Queue a resource file located at path for preview. Once the preview is ready, the receiver's receiver_func will be called. The receiver_func must take the following four arguments: string path, Texture2D preview, Texture2D thumbnail_preview, Variant userdata. userdata can be anything, and will be returned when receiver_func is called. Note: If it was not possible to create the preview the receiver_func will still be called, but the preview will be null.

Parameters
Name	Type	Default
`path`	`string`	—
`receiver`	`ReckfellObject`	—
`receiverFunc`	`StringName`	—
`userdata`	`Variant`	—

RemovePreviewGeneratorvoid

# RemovePreviewGenerator

C#
public void RemovePreviewGenerator(EditorResourcePreviewGenerator generator);

Removes a custom preview generator.

Parameters
Name	Type	Default
`generator`	`EditorResourcePreviewGenerator`	—

Signals and events1

PreviewInvalidatedEvent

# PreviewInvalidated

public event EditorResourcePreview.PreviewInvalidatedEventHandler PreviewInvalidated;

Emitted if a preview was invalidated (changed). path corresponds to the path of the preview.

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