Справочник API

Полный справочник API

Также доступен в сокращенной форме внутри самого редактора:

Конструкторы ресурсов

Конструкторы создают основные типы ресурсов, используемые редактором. Когда вы назначаете один из них переменной, редактор распознает его и позволяет вам открыть соответствующий редактор ресурсов с помощью Ctrl+Click.

Методы списков

Создавайте списки с помощью [] или [value1, value2, ...]. Читайте и перезаписывайте элементы с помощью list[index], и перебирайте с помощью for (var i = 0; i < list.length(); i = i + 1).

Операторы

Операторы - это небольшие символы, которые выполняют общие вычисления. Оператор модуля особенно полезен для циклических таймеров, индексов, шагов анимации или повторяющихся шаблонов.

Свойства объектов

Объекты - это то, что ваш скрипт обычно перемещает и изменяет во время игры. Эти функции читают или обновляют положение объекта, спрайт, поведение столкновения, слой и визуальный оттенок.

Функции спрайтов

Функции спрайтов позволяют коду просматривать или изменять данные пикселей спрайта и скорость анимации. Большинство игр рисуют спрайты в редакторе, но эти функции полезны для процедурных эффектов, отладки или простых изменений во время выполнения.

Функции анимации

Функции анимации работают с объектами, использующими спрайты с несколькими кадрами. Используйте их, когда хотите, чтобы код просматривал или заставлял текущий кадр анимации.

Функции трансформации (Отражение/Поворот)

Функции трансформации изменяют то, как спрайт объекта рисуется без редактирования самого спрайта. Они полезны для повторного использования одного спрайта в нескольких направлениях.

Примечание: Эти трансформации применяются только во время рендеринга. Они не влияют на коллизионные коробки или реальные данные пикселей спрайта.

Типы столкновений

Типы столкновений определяют, как объект участвует в проверках столкновений. Выбирайте тип в зависимости от роли объекта: стены обычно статичные, игроки обычно динамичные, а предметы часто триггеры.

Функции сцены

Функции сцены контролируют, какая сцена активна, какие объекты находятся внутри нее, и настройки для всей сцены, такие как цвет фона и гравитация. Они также предоставляют функции поиска для нахождения объектов в позициях или по имени.

Воспроизведение аудио

Функции воспроизведения аудио начинают и останавливают аудиоресурсы из скрипта. playAudio() возвращает идентификатор, чтобы вы могли позже остановить или проверить конкретный экземпляр воспроизведения.

Функции экрана

Функции экрана помогают, когда вам нужно знать размер окна или преобразовать между пикселями экрана и мировыми позициями. Это полезно для прицеливания мышью, обнаружения щелчков и UI, осведомленного о камере.

Режим окна

Управляйте режимом окна для экспортируемых игр. Эти функции не влияют на воспроизведение в редакторе (редактор имеет более высокий приоритет над состоянием окна).

Пример:

func start() {
    // Установите режим окна (WINDOW_MAXIMIZED - это значение по умолчанию для экспортируемых игр)
    setWindowMode(WINDOW_MAXIMIZED())
}

Примечание: Если setWindowMode() никогда не вызывается в экспортированной игре, по умолчанию используется WINDOW_MAXIMIZED.

Функции UI

UI использует виртуальное разрешение экрана. Стандартное пространство UI - 100 x 100. Размер шрифта может быть увеличен для последующих текстовых виджетов с помощью uiPushFontSize(size) и восстановлен с помощью uiPopFontSize(). Цвета шрифтов могут накапливаться с помощью uiPushFontColor(r, g, b[, a]), а заливки элементов UI могут накапливаться с помощью uiPushElementColor(r, g, b[, a]). Как и в остальной части UI в немедленном режиме, эти переопределения применяются при создании UI текущего кадра. Если заданный размер равен 0 или меньше, движок использует автоматический размер.

Константы состояния UI

Функции UI возвращают константы состояния, чтобы ваш скрипт мог определить, находится ли виджет в состоянии покоя, завис или был нажат. Обычно UI_CLICKED() — это значение, которое вы проверяете для действий кнопки.

Функции камеры

Положение камеры представляет собой центр вида. Масштаб сохраняет постоянный вертикальный обзор мира независимо от размера экрана.

Поведение зума: Зум сохраняет постоянный вертикальный обзор мира независимо от размера окна или соотношения сторон. Широкие экраны показывают больше по горизонтали, но столько же по вертикали.

Функции ввода

Функции ввода позволяют игре реагировать на состояние клавиатуры и мыши. Используйте Pressed для однокадровых действий, Held для непрерывного движения и Released для действий, которые происходят при отпускании кнопки.

Константы кнопок мыши

Константы кнопок мыши передаются в функции ввода мыши. Они делают код проще для восприятия, чем сырые числа.

Константы клавиш

Константы клавиш передаются в функции ввода с клавиатуры. Движок предоставляет буквы, цифры, функциональные клавиши, стрелки и небольшой набор общих специальных клавиш.

Буквы: KEY_A() до KEY_Z()

Цифры: KEY_0() до KEY_9()

Функциональные клавиши: KEY_F1() до KEY_F12()

Специальные клавиши: | Константа | Клавиша | |----------|-----| | KEY_SPACE() | Пробел | | KEY_ENTER() | Enter/Return | | KEY_ESCAPE() | Escape | | KEY_TAB() | Tab | | KEY_BACKSPACE() | Backspace | | KEY_DELETE() | Delete | | KEY_SHIFT() | Shift | | KEY_CTRL() | Control | | KEY_ALT() | Alt | | KEY_LEFT() | Левая стрелка | | KEY_RIGHT() | Правая стрелка | | KEY_UP() | Верхняя стрелка | | KEY_DOWN() | Нижняя стрелка | | KEY_HOME() | Home | | KEY_END() | End |

Математические функции

Вспомогательные функции для выполнения общих расчетов, используемых в движении, анимации, случайности и ограничениях значений. Они делают скрипты короче и легче для чтения.

Вспомогательные функции

Вспомогательные функции - это общие помощники, которые не принадлежат к конкретному типу актива. print() особенно полезна в процессе обучения, потому что показывает, что делает ваш скрипт.

Строковые функции

Строковые функции работают с текстовыми значениями. На данный момент этот раздел намеренно небольшой.

Функции хранения

Сохранение и загрузка игровых данных в файлы. Поддерживает числа, строки, булевы значения и списки (включая вложенные списки). Не поддерживает значения Sprite, Scene, Object или Audio.

Пример: Сохранение и загрузка прогресса игрока

// Сохранение данных игрока
var playerData = [100, "Player1", true, [1, 2, 3]]
var savePath = getAppDataPath() + "/MyGame/save.dat"
if (save(savePath, playerData)) {
    print("Игра сохранена!")
}

// Загрузка данных игрока
if (fileExists(savePath)) {
    var loaded = load(savePath)
    if (loaded != null) {
        var health = loaded[0]
        var name = loaded[1]
        var hasKey = loaded[2]
        var inventory = loaded[3]
    }
}

// Зашифрованное сохранение (чтобы скрыть данные от случайной проверки)
var secretData = ["секрет", 12345]
save(getAppDataPath() + "/MyGame/config.dat", secretData, "binary", "mySecretKey")
var decrypted = load(getAppDataPath() + "/MyGame/config.dat", "mySecretKey")

// Текстовый формат (читаемый человеком, полезный для отладки)
save(getAppDataPath() + "/MyGame/debug.txt", playerData, "text")

Заметки:

• Двоичный формат (по умолчанию) компактен и быстрее
• Текстовый формат читаем человеком, полезен для отладки
• Неправильный ключ шифрования возвращает null (данные будут испорчены)
• Каталоги создаются автоматически при сохранении