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
用于生成资源或文件的预览的节点。
描述
该节点用于生成文件资源的预览。
注意:不应该直接实例化这个类。请使用 EditorInterface.get_resource_previewer() 访问单例。
方法
void |
add_preview_generator(generator: EditorResourcePreviewGenerator) |
void |
check_for_invalidation(path: String) |
void |
queue_edited_resource_preview(resource: Resource, receiver: Object, receiver_func: StringName, userdata: Variant) |
void |
queue_resource_preview(path: String, receiver: Object, receiver_func: StringName, userdata: Variant) |
void |
remove_preview_generator(generator: EditorResourcePreviewGenerator) |
信号
preview_invalidated(path: String) 🔗
预览无效(更改)时发出。path
对应预览的路径。
方法说明
void add_preview_generator(generator: EditorResourcePreviewGenerator) 🔗
创建一个自定义的预览生成器。
void check_for_invalidation(path: String) 🔗
检查资源是否发生变化,如果发生变化,则无效,并发出相应的信号。
void queue_edited_resource_preview(resource: Resource, receiver: Object, receiver_func: StringName, userdata: Variant) 🔗
将正在编辑的 resource
加入预览队列。预览就绪后将调用 receiver
的 receiver_func
。receiver_func
必须接受以下四个参数:String path、Texture2D preview、Texture2D thumbnail_preview、Variant userdata。userdata
可以是任何内容,会在调用 receiver_func
时返回。
注意:无法创建预览时仍会调用 receiver_func
,但预览将为 null
。
void queue_resource_preview(path: String, receiver: Object, receiver_func: StringName, userdata: Variant) 🔗
将位于 path
的资源文件加入预览队列。预览就绪后将调用 receiver
的 receiver_func
。receiver_func
必须接受以下四个参数:String path、Texture2D preview、Texture2D thumbnail_preview、Variant userdata。userdata
可以是任何内容,会在调用 receiver_func
时返回。
注意:无法创建预览时仍会调用 receiver_func
,但预览将为 null
。
void remove_preview_generator(generator: EditorResourcePreviewGenerator) 🔗
移除自定义预览生成器。