Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

EditorResourcePreview¶

Inherits: Node < Object

用于生成资源或文件的预览的节点。

Description¶

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.

Methods¶

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

Signals¶

preview_invalidated ( String path )

预览无效（更改）时发出。path 对应预览的路径。

Method Descriptions¶

void add_preview_generator ( EditorResourcePreviewGenerator generator )

创建一个自定义的预览生成器。

void check_for_invalidation ( String path )

检查资源是否发生变化，如果发生变化，则无效，并发出相应的信号。

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

将正在编辑的 resource 排队以供预览。预览准备就绪后，将调用 receiver 的 receiver_func。receiver_func 必须接受以下四个参数：String path、Texture2D preview、Texture2D thumbnail_preview、Variant userdata。userdata 可以是任何东西，并将在调用 receiver_func 时返回。

注意：如果无法创建预览，receiver_func 仍将被调用，但 preview 将为 null。

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

将位于 path 的资源文件排队以供预览。预览准备就绪后，将调用 receiver 的 receiver_func。receiver_func 必须接受以下四个参数：String path、Texture2D preview、Texture2D thumbnail_preview、Variant userdata。userdata 可以是任何东西，并将在调用 receiver_func 时返回。

注意：如果无法创建预览，receiver_func 仍将被调用，但 preview 将为 null。

void remove_preview_generator ( EditorResourcePreviewGenerator generator )

移除自定义预览生成器。