noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Consistently prefix bound virtual methods with _

Browse Source
This commit is contained in:
kobewi
2021-05-15 23:48:59 +02:00
parent 530e069bc3
commit 7ff135b015
51 changed files with 1107 additions and 1232 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/EditorResourcePreviewGenerator.xml
+8 -8
View File
@@ -9,15 +9,15 @@
<tutorials>
</tutorials>
<methods>
<method name="can_generate_small_preview" qualifiers="virtual">
<method name="_can_generate_small_preview" qualifiers="virtual">
<return type="bool">
</return>
<description>
If this function returns [code]true[/code], the generator will call [method generate] or [method generate_from_path] for small previews as well.
If this function returns [code]true[/code], the generator will call [method _generate] or [method _generate_from_path] for small previews as well.
By default, it returns [code]false[/code].
</description>
</method>
<method name="generate" qualifiers="virtual">
<method name="_generate" qualifiers="virtual">
<return type="Texture2D">
</return>
<argument index="0" name="from" type="Resource">
@@ -30,7 +30,7 @@
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">
<method name="_generate_from_path" qualifiers="virtual">
<return type="Texture2D">
</return>
<argument index="0" name="path" type="String">
@@ -38,20 +38,20 @@
<argument index="1" name="size" type="Vector2">
</argument>
<description>
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method generate].
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _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="generate_small_preview_automatically" qualifiers="virtual">
<method name="_generate_small_preview_automatically" qualifiers="virtual">
<return type="bool">
</return>
<description>
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].
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].
By default, it returns [code]false[/code].
</description>
</method>
<method name="handles" qualifiers="virtual">
<method name="_handles" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="type" type="String">