:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePreview.xml. .. _class_EditorResourcePreview: EditorResourcePreview ===================== **Inherits:** :ref:`Node` **<** :ref:`Object` A node used to generate previews of resources or files. .. rst-class:: classref-introduction-group 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 :ref:`EditorInterface.get_resource_previewer`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_preview_generator`\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`check_for_invalidation`\ (\ path\: :ref:`String`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`queue_edited_resource_preview`\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`queue_resource_preview`\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_preview_generator`\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) | +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_EditorResourcePreview_signal_preview_invalidated: .. rst-class:: classref-signal **preview_invalidated**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Emitted if a preview was invalidated (changed). ``path`` corresponds to the path of the preview. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorResourcePreview_method_add_preview_generator: .. rst-class:: classref-method |void| **add_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) :ref:`🔗` Create an own, custom preview generator. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePreview_method_check_for_invalidation: .. rst-class:: classref-method |void| **check_for_invalidation**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePreview_method_queue_edited_resource_preview: .. rst-class:: classref-method |void| **queue_edited_resource_preview**\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) :ref:`🔗` Queue the ``resource`` being edited for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. \ **Note:** If it was not possible to create the preview the ``receiver_func`` will still be called, but the preview will be ``null``. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePreview_method_queue_resource_preview: .. rst-class:: classref-method |void| **queue_resource_preview**\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) :ref:`🔗` Queue a resource file located at ``path`` for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. \ **Note:** If it was not possible to create the preview the ``receiver_func`` will still be called, but the preview will be ``null``. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePreview_method_remove_preview_generator: .. rst-class:: classref-method |void| **remove_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) :ref:`🔗` Removes a custom preview generator. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`