Inheritance #

EditorResourcePreview

Table of contents

EditorResourcePreview #

resource, Node, editor, not_builtin_classes

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.get_resource_previewer.

Members #

Methods #

func add_preview_generator(generator: EditorResourcePreviewGenerator) -> void#

Create an own, custom preview generator.

func check_for_invalidation(path: String) -> void#

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

func queue_edited_resource_preview(userdata: Variant) -> void#

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.

func queue_resource_preview(userdata: Variant) -> void#

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.

func remove_preview_generator(generator: EditorResourcePreviewGenerator) -> void#

Removes a custom preview generator.

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal preview_invalidated(path: String)#

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

Theme Items #

Tutorials #