f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
67 lines
3.3 KiB
XML
67 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="EditorResourcePreview" inherits="Node" version="3.4">
|
|
<brief_description>
|
|
Helper to generate previews of resources or files.
|
|
</brief_description>
|
|
<description>
|
|
This object is used to generate previews for resources of files.
|
|
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_previewer].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_preview_generator">
|
|
<return type="void" />
|
|
<argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
|
|
<description>
|
|
Create an own, custom preview generator.
|
|
</description>
|
|
</method>
|
|
<method name="check_for_invalidation">
|
|
<return type="void" />
|
|
<argument index="0" name="path" type="String" />
|
|
<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" />
|
|
<argument index="0" name="resource" type="Resource" />
|
|
<argument index="1" name="receiver" type="Object" />
|
|
<argument index="2" name="receiver_func" type="String" />
|
|
<argument index="3" name="userdata" type="Variant" />
|
|
<description>
|
|
Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
|
|
[b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
|
|
</description>
|
|
</method>
|
|
<method name="queue_resource_preview">
|
|
<return type="void" />
|
|
<argument index="0" name="path" type="String" />
|
|
<argument index="1" name="receiver" type="Object" />
|
|
<argument index="2" name="receiver_func" type="String" />
|
|
<argument index="3" name="userdata" type="Variant" />
|
|
<description>
|
|
Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
|
|
[b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
|
|
</description>
|
|
</method>
|
|
<method name="remove_preview_generator">
|
|
<return type="void" />
|
|
<argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
|
|
<description>
|
|
Removes a custom preview generator.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<signals>
|
|
<signal name="preview_invalidated">
|
|
<argument index="0" name="path" type="String" />
|
|
<description>
|
|
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|