Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

EditorResourceTooltipPlugin

Успадковує: RefCounted < Object

Додаток, який передовий інструмент для його ручного типу ресурсу.

Опис

Resource Tooltip плагіни використовуються FileSystemDock для створення індивідуальних інструментів для конкретних ресурсів. E.g. Інструмент для Texture2D відображає більший попередній перегляд та розміри текстури.

Додаток повинен бути першим зареєстрованим за допомогою FileSystemDock.add_resource_tooltip_plugin(). Коли користувач працює ресурс у файлосистемі dock, який обробляється плагіном, _make_tooltip_for_path() називається для створення інструменту. Працює аналогічно Control._make_custom_tooltip().

Методи

bool

_handles(type: String) virtual const

Control

_make_tooltip_for_path(path: String, metadata: Dictionary, base: Control) virtual const

void

request_thumbnail(path: String, control: TextureRect) const


Описи методів

bool _handles(type: String) virtual const 🔗

Повернути true, якщо плагін оброблятиме заданий Resource type param.


Control _make_tooltip_for_path(path: String, metadata: Dictionary, base: Control) virtual const 🔗

Створіть і поверніть спливаючу підказку, яка відображатиметься, коли користувач наведе курсор миші на ресурс під заданим path у доку файлової системи.

The metadata dictionary is provided by preview generator (see EditorResourcePreviewGenerator._generate()).

base — базова спливаюча підказка за замовчуванням, яка є VBoxContainer із назвою файлу, типом і мітками розміру. Якщо інший плагін обробив той самий тип файлу, base буде виведено з попереднього плагіна. Щоб отримати найкращий результат, переконайтеся, що базова підказка є частиною повернутого Control.

Примітка. Не рекомендується використовувати ResourceLoader.load(), особливо з такими важкими ресурсами, як моделі чи текстури, оскільки це призведе до того, що редактор перестане реагувати під час створення підказки. Ви можете використовувати request_thumbnail(), якщо хочете відобразити попередній перегляд у підказці.

Примітка: Якщо ви вирішите скинути base, обов’язково викликайте Node.queue_free(), оскільки він не звільняється автоматично.

func _make_tooltip_for_path(path, metadata, base):
    var t_rect = TextureRect.new()
    request_thumbnail(path, t_rect)
    base.add_child(t_rect) # TextureRect з’явиться внизу підказки.
    return base

void request_thumbnail(path: String, control: TextureRect) const 🔗

Запити на ескіз TextureRect. thumbnail створюється асинхронно EditorResourcePreview і автоматично встановлюється при наявності.