Class EditorResourcePreview

A node used to generate previews of resources or files.

Inheritance

Node

Object

EditorResourcePreview

Remarks

This node is used to generate previews for resources or files.

Note: This class shouldn't be instantiated directly. Instead, access the singleton using get_resource_previewer.

Methods

add_preview_generator(EditorResourcePreviewGenerator)

Create an own, custom preview generator.

void add_preview_generator(EditorResourcePreviewGenerator generator)

Parameters

generator EditorResourcePreviewGenerator

check_for_invalidation(String)

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

void check_for_invalidation(String path)

Parameters

path String

queue_edited_resource_preview(Resource, Object, StringName, Variant)

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.

void queue_edited_resource_preview(Resource resource, Object receiver, StringName receiver_func, Variant userdata)

Parameters

resource Resource

receiver Object

receiver_func StringName

userdata Variant

queue_resource_preview(String, Object, StringName, Variant)

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.

void queue_resource_preview(String path, Object receiver, StringName receiver_func, Variant userdata)

Parameters

path String

receiver Object

receiver_func StringName

userdata Variant

remove_preview_generator(EditorResourcePreviewGenerator)

Removes a custom preview generator.

void remove_preview_generator(EditorResourcePreviewGenerator generator)

Parameters

generator EditorResourcePreviewGenerator

Events

preview_invalidated(String)

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

signal preview_invalidated(String path)

Parameters

path String