2d20fc39aa
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
82 lines
2.8 KiB
XML
82 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="EditorResourcePreview" inherits="Node" version="3.2">
|
|
<brief_description>
|
|
Helper to generate previews of resources or files.
|
|
</brief_description>
|
|
<description>
|
|
This object is used to generate previews for resources of files.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_preview_generator">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
|
|
</argument>
|
|
<description>
|
|
Create an own, custom preview generator.
|
|
</description>
|
|
</method>
|
|
<method name="check_for_invalidation">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="path" type="String">
|
|
</argument>
|
|
<description>
|
|
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
|
|
</description>
|
|
</method>
|
|
<method name="queue_edited_resource_preview">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="resource" type="Resource">
|
|
</argument>
|
|
<argument index="1" name="receiver" type="Object">
|
|
</argument>
|
|
<argument index="2" name="receiver_func" type="String">
|
|
</argument>
|
|
<argument index="3" name="userdata" type="Variant">
|
|
</argument>
|
|
<description>
|
|
Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
|
</description>
|
|
</method>
|
|
<method name="queue_resource_preview">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="path" type="String">
|
|
</argument>
|
|
<argument index="1" name="receiver" type="Object">
|
|
</argument>
|
|
<argument index="2" name="receiver_func" type="String">
|
|
</argument>
|
|
<argument index="3" name="userdata" type="Variant">
|
|
</argument>
|
|
<description>
|
|
Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything.
|
|
</description>
|
|
</method>
|
|
<method name="remove_preview_generator">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
|
|
</argument>
|
|
<description>
|
|
Removes a custom preview generator.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<signals>
|
|
<signal name="preview_invalidated">
|
|
<argument index="0" name="path" type="String">
|
|
</argument>
|
|
<description>
|
|
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|