API Reference

Полная справка по API

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

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

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

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

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

Операторы

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

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

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

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

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

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

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

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

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

Стандартный центр смещения — [0.5, 0.5], что вращает вокруг центра спрайта. [0, 0] вращает вокруг верхнего левого угла объекта, и [1, 1] вращает вокруг location + (width, height).

Внимание для более старых проектов: Начиная с Tiniest2D 1.8, getRotation() и setRotation() используют углы в градусах вместо значений четверти поворота. Вращаемые коллайдеры объектов теперь влияют на физику и запросы сцены.

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

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

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

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

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

Функции воспроизведения звука запускают и останавливают аудиоресурсы из скрипта. 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() | Ввод/Возврат | | KEY_ESCAPE() | Эскейп | | KEY_TAB() | Таб | | KEY_BACKSPACE() | Backspace | | KEY_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 = ["secret", 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 (данные будут мусором)
• Директории создаются автоматически при сохранении