asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/EditorResourcePreviewGenerator.xml

57 lines
2.5 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Rename Reference to RefCounted
2021-06-04 18:03:15 +02:00
<class name="EditorResourcePreviewGenerator" inherits="RefCounted" version="4.0">
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 22:42:36 +02:00
<brief_description>
Custom generator of previews.
</brief_description>
<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-22 01:04:47 +02:00
Custom code to generate previews. Please check [code]file_dialog/thumbnail_size[/code] in [EditorSettings] to find out the right size to do previews at.
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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
<method name="_can_generate_small_preview" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` 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.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Renamed EditorResourcePreviewGenerator.should_generate_small_preview() to generate_small_preview_automatically() Added can_generate_small_preview() so the generator uses generate() or generate_from_path() if it returns true Added can_generate_small_preview() and generate_small_preview_automatically() to the scripting languages
2019-05-20 10:45:12 +02:00
<description>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
If this function returns [code]true[/code], the generator will call [method _generate] or [method _generate_from_path] for small previews as well.
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-22 01:04:47 +02:00
By default, it returns [code]false[/code].
Renamed EditorResourcePreviewGenerator.should_generate_small_preview() to generate_small_preview_automatically() Added can_generate_small_preview() so the generator uses generate() or generate_from_path() if it returns true Added can_generate_small_preview() and generate_small_preview_automatically() to the scripting languages
2019-05-20 10:45:12 +02:00
</description>
</method>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
<method name="_generate" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` 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.
2021-07-30 15:28:05 +02:00
<return type="Texture2D" />
<argument index="0" name="from" type="Resource" />
<argument index="1" name="size" type="Vector2" />
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 22:42:36 +02:00
<description>
doc: Sync classref with current source
2018-09-21 09:33:05 +02:00
Generate a preview from a given resource with the specified size. This must always be 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).
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 22:42:36 +02:00
</description>
</method>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
<method name="_generate_from_path" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` 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.
2021-07-30 15:28:05 +02:00
<return type="Texture2D" />
<argument index="0" name="path" type="String" />
<argument index="1" name="size" type="Vector2" />
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 22:42:36 +02:00
<description>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate].
doc: Sync classref with current source
2018-09-21 09:33:05 +02:00
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).
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 22:42:36 +02:00
</description>
</method>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
<method name="_generate_small_preview_automatically" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` 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.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Renamed EditorResourcePreviewGenerator.should_generate_small_preview() to generate_small_preview_automatically() Added can_generate_small_preview() so the generator uses generate() or generate_from_path() if it returns true Added can_generate_small_preview() and generate_small_preview_automatically() to the scripting languages
2019-05-20 10:45:12 +02:00
<description>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method _generate] or [method _generate_from_path].
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-22 01:04:47 +02:00
By default, it returns [code]false[/code].
Renamed EditorResourcePreviewGenerator.should_generate_small_preview() to generate_small_preview_automatically() Added can_generate_small_preview() so the generator uses generate() or generate_from_path() if it returns true Added can_generate_small_preview() and generate_small_preview_automatically() to the scripting languages
2019-05-20 10:45:12 +02:00
</description>
</method>
Consistently prefix bound virtual methods with _
2021-05-15 23:48:59 +02:00
<method name="_handles" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` 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.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="type" type="String" />
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 22:42:36 +02:00
<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-22 01:04:47 +02:00
Returns [code]true[/code] if your generator supports the resource of type [code]type[/code].
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 22:42:36 +02:00
</description>
</method>
</methods>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink