EditorResourcePreview

Inherits: Node < Object

帮助生成资源或文件的预览。

描述

该对象用于生成文件资源的预览。

注意:不应该直接实例化这个类,而是使用EditorInterface.get_resource_previewer访问单例。而是,使用EditorInterface.get_resource_previewer访问单例。

方法

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 )

信号

  • preview_invalidated ( String path )

预览无效(更改)时触发。path对应的预览路径。

方法说明

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


  • void check_for_invalidation ( String path )

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


将正在编辑的资源 resource 排队进行预览。一旦预览准备好了,接收器 receiverreceiver_func 将被调用。receiver_func 必须接受以下四个参数。String path, Texture preview, Texture thumbnail_preview, Variant userdata。userdata 可以是任何东西,并将在 receiver_func 被调用时返回。

注意:如果无法创建预览,receiver_func 仍将被调用,但预览将为空。


将位于路径 path 的资源文件排队以进行预览。预览准备好后,将调用 receiverreceiver_func 函数。receiver_func 必须带有以下四个参数:String path、Texture preview、Texture thumbnail_preview、Variant userdata。用户数据 userdata 可以是任意的,会在调用 receiver_func 时返回。

注意:无法创建预览时仍将调用 receiver_func,但 preview 会是 null。


移除自定义预览生成器。