diff options
Diffstat (limited to 'doc/classes/EditorResourcePreviewGenerator.xml')
| -rw-r--r-- | doc/classes/EditorResourcePreviewGenerator.xml | 30 |
1 files changed, 10 insertions, 20 deletions
diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index 3594474e36..7054b1f4d0 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -10,20 +10,16 @@ </tutorials> <methods> <method name="_can_generate_small_preview" qualifiers="virtual"> - <return type="bool"> - </return> + <return type="bool" /> <description> 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"> - <return type="Texture2D"> - </return> - <argument index="0" name="from" type="Resource"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> + <return type="Texture2D" /> + <argument index="0" name="from" type="Resource" /> + <argument index="1" name="size" type="Vector2" /> <description> 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. @@ -31,12 +27,9 @@ </description> </method> <method name="_generate_from_path" qualifiers="virtual"> - <return type="Texture2D"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> + <return type="Texture2D" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="size" type="Vector2" /> <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]. Returning an empty texture is an OK way to fail and let another generator take care. @@ -44,18 +37,15 @@ </description> </method> <method name="_generate_small_preview_automatically" qualifiers="virtual"> - <return type="bool"> - </return> + <return type="bool" /> <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]. By default, it returns [code]false[/code]. </description> </method> <method name="_handles" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="type" type="String"> - </argument> + <return type="bool" /> + <argument index="0" name="type" type="String" /> <description> Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. </description> |