FOnline Engine
Current master GitHub
Документация Docs/ru/reference/script-api/index.md

Сгенерированный справочник API

Сгенерированный справочник. Не редактируйте эти страницы вручную. Канонический вход — Docs/generated/api.json, созданный нативным parser metadata codegen движка.

Этот справочник описывает объявления в области engine-native-codegen модели. Текущий инвентарь доступен встраиваемым проектам как experimental API с точной привязкой к ревизии; широкого обещания стабильной совместимости это не создаёт.

Справочник Символы Покрытие
Нативные методы скриптов 997 Нативные методы, экспортированные в скрипты.
Свойства сущностей 132 Сгенерированные контракты свойств сущностей.
События движка 122 События сервера, клиента, общей стороны и Mapper.
Типы скриптов 997 Сущности, enum, value/reference types, поля и методы.
Настройки движка 279 Настройки движка только для чтения, сгруппированные по областям.
Правила миграции 28 Объявления миграции нативной metadata.

Качество модели

Сигнал Количество
Адресуемые символы 2555
Символы с описаниями 2555
Символы без описаний 0
Символы без provenance исходника 14
Файлы-источники metadata 43
Явные объявления контракта 3
Явно классифицированные символы 2555
Неклассифицированные символы по умолчанию 0

Метки стабильности

Метка Символы
experimental 2554
internal 1

Контракт области

Полный текущий инвентарь имеет статус experimental с версии 2022.1.0.wip. Объявление закрепляет 2555 стабильных ID хешем SHA-256 7a8bef24e97c589f0113e44ee76aaacfc531585cd0203ca075b38bbbe8560ccf; любое добавление или удаление символа либо изменение стабильного ID останавливает генерацию, пока владелец не проверит и не обновит оба пина.

Поверхность native-codegen предлагается только для оценки и остаётся привязанной к ревизии до появления поддерживаемых веток выпусков.
SymbolCount и InventorySha256 требуют проверки владельцем каждого добавления, удаления или изменения стабильного ID.

Исходник контракта: Source/Common/Common.h:47

Область

Включено:

  • нативные script enum, value/reference types, сущности, свойства, методы и события
  • настройки движка, разобранные из ExportSettings
  • нативные правила миграции
  • заданные в исходниках API-контракты, разобранные из ApiContract

Исключено из текущей модели:

  • проектная script metadata, включая remote calls
  • options CMake и helpers стадий
  • интерфейсы командной строки BuildTools
  • схемы пакетов и детали ABI нативных расширений

Project-facing объявления CMake намеренно находятся вне этой модели; используйте отдельный сгенерированный справочник project interface CMake.

Основная командная строка BuildTools также находится вне этой модели; используйте отдельный справочник CLI на основе parser.

Объявления пакетов и payload используют отдельный контракт, потребляемый runtime; смотрите справочник интерфейса пакетов.

Ссылки на исходники следуют ветке master репозитория. Путь и строка в каноническом JSON являются сгенерированной provenance-записью; ссылки с точной привязкой к ревизии остаются частью roadmap публикации.

Введите запрос.