hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
recognize them.
This commit is contained in:
Juan Linietsky 2017-09-12 17:42:36 -03:00
parent 175777596e
commit 4f929a0fdf
471 changed files with 63732 additions and 61317 deletions
Download patch file Download diff file Expand all files Collapse all files

48
doc/classes/EditorResourcePreviewGenerator.xml Normal file
View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Custom generator of previews.
</brief_description>
<description>
Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="generate" qualifiers="virtual">
<return type="Texture">
</return>
<argument index="0" name="from" type="Resource">
</argument>
<description>
Generate a preview from a given resource. This must be always implemented.
Returning an empty texture is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
</description>
</method>
<method name="generate_from_path" qualifiers="virtual">
<return type="Texture">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Generate a preview directly from a path, implementing this is optional, as default code will load and call generate()
Returning an empty texture is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
</description>
</method>
<method name="handles" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Return if your generator supports this resource type.
</description>
</method>
</methods>
<constants>
</constants>
</class>