1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<?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.
[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">
</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>
|
