godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EditorResourcePreview.xml

83 lines
3.0 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref with 3.3 version bump
2021-03-23 12:40:34 +00:00
<class name="EditorResourcePreview" inherits="Node" version="3.3">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Helper to generate previews of resources or files.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
This object is used to generate previews for resources of files.
Document how some editor classes should be accessed as singletons only This closes #37687. (cherry picked from commit a225265b0a7308f0856c953f57168c490d54995e)
2020-04-14 20:09:21 +00:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_previewer].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Fixed typo: 'texure' to 'texture'
2017-09-28 21:40:01 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Fixed typo: 'texure' to 'texture'
2017-09-28 21:40:01 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_preview_generator">
<return type="void">
</return>
<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Removes a custom preview generator.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<signals>
<signal name="preview_invalidated">
<argument index="0" name="path" type="String">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
</constants>
</class>