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
A node used to generate previews of resources or files.
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().
Méthodes
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) |
Signaux
preview_invalidated(path: String) 🔗
Émis si un aperçu a été invalidé (c'est-à-dire changé). path correspond au chemin de l'aperçu.
Descriptions des méthodes
void add_preview_generator(generator: EditorResourcePreviewGenerator) 🔗
Créez un générateur d’aperçu personnalisé.
void check_for_invalidation(path: String) 🔗
Vérifiez si la ressource a changé, si oui, elle sera invalidée et le signal correspondant émis.
void queue_edited_resource_preview(resource: Resource, receiver: Object, receiver_func: StringName, userdata: Variant) 🔗
Met la resource modifiée en attente pour être prévisualisée. Une fois la prévisualisation prête, la méthode receiver_func du receiver sera appelée. Le receiver_func doit prendre les quatre arguments suivants : le chemin ("path") String, la Texture de l'aperçu ("preview"), la Texture de la vignette ("thumbnail_preview") et les données personnées ("userdata") sous forme de Variant. userdata peut contenir n'importe quel type de données, et sera retourné quand receiver_func sera appelé.
Note : S'il n'était pas possible de créer la prévisualisation, receiver_func sera toujours appelé, mais la prévisualisation sera null.
void queue_resource_preview(path: String, receiver: Object, receiver_func: StringName, userdata: Variant) 🔗
Met le fichier de ressource situé à path en attente pour être prévisualisé. Une fois la prévisualisation prête, la méthode receiver_func du receiver sera appelée. Le receiver_func doit prendre les quatre arguments suivants : le chemin ("path") String, la Texture de l'aperçu ("preview"), la Texture de la vignette ("thumbnail_preview") et les données personnées ("userdata") sous forme de Variant. userdata peut contenir n'importe quel type de données, et sera retourné quandreceiver_func sera appelé.
Note : S'il n'était pas possible de créer la prévisualisation, receiver_func sera toujours appelé, mais la prévisualisation sera null.
void remove_preview_generator(generator: EditorResourcePreviewGenerator) 🔗
Supprime un générateur d’aperçu personnalisé.