EditorResourcePreview

Inherits: :ref:`Node<class_Node>` < :ref:`Object<class_Object>`

Helper to generate previews of resources or files.

Description

This object is used to generate previews for resources of files.

Methods

Signals

• preview_invalidated ( :ref:`String<class_String>` path )

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

Method Descriptions

• void add_preview_generator ( :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator )

Create an own, custom preview generator.

• void check_for_invalidation ( :ref:`String<class_String>` path )

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

• void queue_edited_resource_preview ( :ref:`Resource<class_Resource>` resource, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata )

Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.

• void queue_resource_preview ( :ref:`String<class_String>` path, :ref:`Object<class_Object>` receiver, :ref:`StringName<class_StringName>` receiver_func, :ref:`Variant<class_Variant>` userdata )

Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.

• void remove_preview_generator ( :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>` generator )

Removes a custom preview generator.