godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Small rework of tooltip plugins

Browse Source
This commit is contained in:
kobewi
2023-05-18 17:03:22 +02:00
parent 6101240231
commit 5baebf75f2
5 changed files with 26 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/classes/EditorResourceTooltipPlugin.xml
View File

@@ -18,20 +18,23 @@
</description>
</method>
<method name="_make_tooltip_for_path" qualifiers="virtual const">
<return type="Object" />
<return type="Control" />
<param index="0" name="path" type="String" />
<param index="1" name="metadata" type="Dictionary" />
<param index="2" name="base" type="Control" />
<description>
Create and return a tooltip that will be displayed when the user hovers resource under given [param path] in filesystem dock. For best results, use [method make_default_tooltip] as a base.
Create and return a tooltip that will be displayed when the user hovers a resource under the given [param path] in filesystem dock.
The [param metadata] dictionary is provided by preview generator (see method EditorResourcePreviewGenerator._generate]).
[param base] is the base default tooltip, which is a [VBoxContainer] with a file name, type and size labels. If another plugin handled the same file type, [param base] will be output from the previous plugin. For best result, make sure the base tooltip is part of the returned [Control].
[b]Note:[/b] It's unadvised to use [method ResourceLoader.load], especially with heavy resources like models or textures, because it will make the editor unresponsive when creating the tooltip. You can use [method request_thumbnail] if you want to display a preview in your tooltip.
</description>
</method>
<method name="make_default_tooltip" qualifiers="static">
<return type="VBoxContainer" />
<param index="0" name="path" type="String" />
<description>
Creates a default file tooltip. The tooltip includes file name, file size and [Resource] type if available.
[b]Note:[/b] If you decide to discard the [param base], make sure to call [method Node.queue_free], because it's not freed automatically.
[codeblock]
func _make_tooltip_for_path(path, metadata, base):
var t_rect = TextureRect.new()
request_thumbnail(path, t_rect)
base.add_child(t_rect) # The TextureRect will appear at the bottom of the tooltip.
return base
[/codeblock]
</description>
</method>
<method name="request_thumbnail" qualifiers="const">