LeCodesdocs

Справочник API

Полный справочник API для проектов le.codes. Всё здесь — глобальные значения без импортов: пользовательский код обращается к Scene, Sprite, UIScreen, fetch, … напрямую, а сборка подставляет реализацию и вырезает то, что проект не использует.

Если вы только начинаете — загляните в раздел Соглашения: единицы измерения, системы координат, семантика значений и правила жизненного цикла, на которые опирается каждая страница. Глобалы, предоставляемые хостом (setLoop, таймеры, asset(), …), собраны на странице Глобалы хоста.

Заметка

Это справочник по поверхности API. Руководства и разобранные примеры — отдельный раздел (Гайд и Примеры), он появится позже.

Как читать сигнатуры

Сигнатуры записаны как упрощённый TypeScript — без шума перегрузок и вспомогательных дженериков. Значения по умолчанию показаны комментарием (// по умолчанию 1), необязательные параметры помечены ?, а единицы измерения всегда названы там, где число пересекает границу API: секунды или миллисекунды, градусы или радианы, логические пиксели или мировые единицы.

TypeScript
Mathf.lerp(a, b, t): number            // a + (b − a)·t
sprite.setFramePx(x, y, w, h): this    // под-прямоугольник в пикселях текстуры
animate(target, to, 300)               // длительность в миллисекундах

Разделы

  • Математика — скаляры, векторы, кватернионы, матрицы и цвет: Mathf, Vec2 и Vec3, Quat, Mat4, Color.
  • ЯдроAspect (возможности узлов), реактивность signal / computed / effect, Canvas и модель событий.
  • Рантаймdevice, ввод и касания, fetch / WebSocket, localStorage, аудио и видео, файлы и системный шеринг, даты (date).
  • Анимацияanimate и функции сглаживания.
  • 2D-движокScene2D, Node2D, Sprite, физика Box2D, тайлмапы.
  • 3D-движокScene, ARScene, меши и модели, материалы, свет, физика Jolt, частицы.
  • UI — модель элементов, стилизация, контейнеры, текст и медиа, кнопки и поля ввода, экраны и роутер, виджеты, виртуализированные списки, шрифты.
  • ПлагиныCameraViewer, QRScanner и другие возможности, зависящие от хоста.
Совет

Слева — полное дерево навигации по всем разделам. Справочник переведён целиком — все страницы доступны на русском и английском.