API Manual and Inspector - LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE GitHub Wiki
API Manual и Inspector
Все команды · Расширенные карточки · Состояние проверки
Кнопка API Manual в IDE открывает справочник с поиском и списком команд. Выбор команды показывает синтаксис, параметры, возвращаемое значение, ограничения и примеры. Файлы лежат во внешней папке API Manual: например, UO.Info.md, UO.FindCount.md, UO.GetTooltipRec.md. Их можно открывать, копировать и редактировать отдельно. Кнопка Source открывает файл выбранной карточки.
Язык выбирается по локализации клиента/IDE. Переводы хранятся в подпапках en, ru, uk, fr, de, it, es, zh-tw, ja, ko. Если перевода нет, используется английская или корневая карточка. Переводы всех команд ещё не закончены; запасной текст не считается переводом. Названия команд и параметры в коде не переводятся.
Окно клиента перечитывает файл при выборе команды. В Theia повторно откройте API Manual после изменения внешнего файла. Генератор проекта перезаписывает карточки: изменения, которые нужно сохранить при регенерации, вносите в его исходные описания.
Панель вызовов API показывает события реального выполнения скрипта: команду, аргументы, статус и результат. Пустой результат Unit означает отсутствие возвращаемого значения, а не успех на сервере. Панели переменных показывают глобальные и локальные значения. Справочник не запускает выбранную команду автоматически.
InfoGump исследует серверное окно и ButtonID; Info — игровой объект; InfoTile — клетку карты. Эти инструменты доступны как команды и отличаются от справочника API.
Отдельные разделы справочника
Нажмите API Manual в верхней панели IDE. В справочнике выберите команду, затем нужный раздел в списке Открыть панель. Кнопка ↗ рядом с заголовком раздела делает то же самое. Повторный выбор уже открытого раздела переключает на его вкладку.
| Панель | Что в ней находится |
|---|---|
| Навигация | Поиск, фильтры и список элементов API |
| Команда | Описание выбранного элемента целиком |
| Сигнатура | Формы вызова и тип результата |
| Описание | Назначение команды |
| Параметры | Имена аргументов, типы и допустимые значения |
| Возвращает | Значение результата и его смысл |
| Как работает | Пояснения выполнения из карточки команды |
| Примеры | Готовые фрагменты и скрипты с кнопками копирования |
| Ссылки | Связанные элементы из каталога |
| Граф вызовов | Связи вызовов, известные каталогу |
| Граф зависимостей | Зависимости, известные каталогу |
| Исходник | Доступное описание исходника и переход к файлу |
| Техническая информация | Метаданные, связи и ограничения элемента |
Каждую панель можно закрепить слева, справа, сверху или снизу, отделить в собственное окно и развернуть. Эти действия находятся в заголовке вкладки IDE. Размеры закреплённых панелей меняются разделителями; размеры отдельных окон — их границами. Чтобы вернуть отдельное окно в IDE, используйте действие закрепления.
Изменение размеров внутри общего окна
В общей вкладке API Manual тоже есть перетягиваемые границы. Граница справа от навигации меняет ширину списка команд, граница слева от технической информации — ширину правой панели. Между текстом карточки и примерами можно двигать горизонтальную границу вверх и вниз. Достаточно навести курсор на границу, зажать левую кнопку мыши и перетащить её.
Размеры сохраняются при выборе другой команды, смене языка справочника и повторном открытии IDE. Двойной щелчок по границе возвращает её размер по умолчанию. Границу можно выбрать клавишей Tab и перемещать стрелками; Shift увеличивает шаг. Home и End выбирают минимальный и максимальный допустимые размеры.
У каждой области остаётся минимальное место для чтения, поэтому перетягивание не накладывает соседние разделы друг на друга. В узком окне навигация размещается над карточкой: её граница тогда двигается вверх и вниз. В очень низком окне включается прокрутка. Техническую информацию можно открыть через список панелей даже тогда, когда общая правая колонка скрыта из-за ширины окна.
Для отдельного размера любого подраздела — например, только «Параметры», «Возвращает» или «Примеры» — откройте его кнопкой ↗. Затем изменяйте его закреплённую область разделителем IDE либо отделите панель и растяните собственное окно. Это доступно для всех 13 разделов из таблицы.
Выбор команды общий: например, после выбора UO.Follow панели параметров, результата и примеров показывают сведения именно о UO.Follow. Затем выберите UO.Random — открытые панели переключатся вместе. Для удобного чтения можно оставить навигацию слева, параметры справа, а примеры развернуть отдельно.
Закрытие общей вкладки API Manual не закрывает отдельные разделы. Их можно закрывать по одному. При обычном закрытии и повторном открытии IDE восстанавливаются открытые разделы, выбранная команда, поиск, фильтры и положение прокрутки. Отделённые окна возвращаются в основную раскладку при закрытии главного окна IDE. Закрытие справочника не останавливает скрипты.
Это документация, а не выполнение команды: кнопка копирования переносит пример в буфер обмена, но не запускает его. Графы показывают только связи из каталога; отсутствие связи не доказывает отсутствие внутреннего вызова. Содержимое разделов зависит от полноты конкретной карточки. Наличие панели само по себе не означает, что описание всех команд и переводы уже проверены.
Тематическая навигация внутри клиента
Кнопка API Manual в верхней панели открывает справочник на рабочую область IDE. Слева доступны 12 основных разделов, в том числе начало работы, язык BASIC, константы, примеры, AutoLoad, сборка и решение проблем. Раздел UO API содержит 36 тем: персонаж, предметы, поиск, бой, движение, заклинания, навыки и другие задачи.
Раскройте раздел и тему, затем выберите команду. Верхняя ссылка раздела открывает обзор; ссылки в обзоре ведут к локальным карточкам параметров и команд. Например: UO API → Movement → UO.Follow. Поиск работает по названиям, параметрам и тексту справочных страниц. Дерево прокручивается отдельно от заголовка; выбранная команда и раскрытые группы сохраняются в состоянии окна.
Материалы читаются из внешней папки API Manual, подключение к GitHub во время чтения не требуется. Раздел Age of Power остаётся только на Wiki и не включается в клиент. Названия разделов интерфейса поддерживают десять языков; содержание выбирает имеющийся перевод и затем запасной файл. Это не означает, что перевод всех карточек уже завершён.