Описание проекта ​

API Melonity позволяет создавать собственные скрипты как для стандартных, так и для пользовательских режимов игры.

С его помощью можно создавать скрипты, работающие с игровыми сущностями, callback-обработчиками, рендерингом, пунктами меню и другими системами времени выполнения, доступными в Melonity.

Рекомендуемый порядок работы ​

Melonity загружает JavaScript во время выполнения, но разрабатывать скрипты лучше в процессе на базе TypeScript с последующей компиляцией в JavaScript.

Этот подход дает вам:

• проверка типа
• автозаполнение
• лучшая поддержка редактора
• более удобная работа с API

Декларации ​

Самые актуальные объявления TypeScript поддерживаются в GitHub-репозитории шаблона.

Когда объявления API обновляются, сначала обновляется папка declarations в шаблонном проекте. Если вам нужны самые свежие файлы объявлений, используйте версию из репозитория шаблона, а не более старую локальную копию.

Для кого предназначена эта документация ​

Эта документация рассчитана на пользователей, которые уже понимают основы JavaScript или TypeScript и хотят структурированно разрабатывать скрипты для Melonity.

Это не просто API-справочник. Здесь также есть практические руководства по настройке и работе со скриптами.

Структура документации ​

Документация разделена на несколько основных частей:

• Раздел Getting started посвящён настройке окружения, первому скрипту и устранению неполадок
• Раздел Best practices посвящён практическим рекомендациям и структуре кода
• Разделы Classes и Enums служат API-справочником

Инструменты разработчика ​

Если вы новичок в документации, следующим шагом откройте раздел Preparing the environment.