Описание проекта
API Melonity позволяет создавать собственные скрипты как для стандартных, так и для пользовательских режимов игры.
С его помощью вы можете создавать сценарии, которые работают с игровыми объектами, callbacks, рендерингом, параметрами menu и другими системами выполнения, предоставляемыми Melonity.
Рекомендуемый рабочий процесс
Melonity загружает JavaScript во время выполнения, но сценарии лучше всего разрабатывать с помощью рабочего процесса на основе TypeScript, а затем компилировать в JavaScript.
Этот подход дает вам:
- проверка типа
- автозаполнение
- лучшая поддержка редактора
- более четкое использование API
Совет
Если вы начинаете с нуля, используйте шаблон проекта и следуйте Preparing the environment.
Декларации
Самые актуальные объявления TypeScript хранятся в репозитории шаблонов GitHub.
Когда объявления API обновляются, declarations папка в проекте шаблона обновляется первой. Если вам нужны последние файлы объявлений, используйте версию из репозитория шаблонов, а не полагайтесь на более старую локальную копию.
Для кого предназначена эта документация
Эта документация предназначена для пользователей, которые уже понимают основы JavaScript или TypeScript и хотят структурированно создавать сценарии Melonity.
Это не только ссылка на API. Он также включает практические руководства по настройке и рабочему процессу.
Внимание
API предназначен для людей, знакомых с основами JavaScript и имеющих минимальный практический опыт. Пожалуйста, воздержитесь от вопросов, связанных с документацией, в службу технической поддержки Melonity, поскольку они будут проигнорированы.
Структура документации
Документация разделена на несколько основных частей:
Getting startedдля настройки среды, первого сценария и устранения неполадокBest practicesза практические рекомендации и структуру кодаClassesиEnumsдля справки по API
Инструменты разработчика
Совет
Во время игры вы можете нажать F11 для доступа к инструментам разработчика.
Если вы новичок в документации, лучшим следующим шагом будет Preparing the environment.