W3cubDocs

/Godot 3.0

EditorResourcePreview

Inherits: Node < Object

Category: Core

Brief Description

Helper to generate previews of resources or files.

Member Functions

void add_preview_generator ( EditorResourcePreviewGenerator generator )
void check_for_invalidation ( String path )
void queue_edited_resource_preview ( Resource resource, Object receiver, String receiver_func, Variant userdata )
void queue_resource_preview ( String path, Object receiver, String receiver_func, Variant userdata )
void remove_preview_generator ( EditorResourcePreviewGenerator generator )

Signals

preview_invalidated ( String path )

If a preview was invalidated (changed) this signal will emit (using the path of the preview)

Description

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

Member Function Description

void add_preview_generator ( EditorResourcePreviewGenerator generator )

Create an own, custom preview generator.

void check_for_invalidation ( String path )

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

void queue_edited_resource_preview ( Resource resource, Object receiver, String receiver_func, 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 ( String path, Object receiver, String receiver_func, 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 ( EditorResourcePreviewGenerator generator )

Remove a custom preview generator.

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_editorresourcepreview.html