API

Об API #

Этот раздел — справочник по публичному API движка LeCodes.

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

Область действия #

API охватывает две основные подсистемы:

Scene — 3D/AR движок: сцены, сущности, камера, меши, материалы, загрузка моделей/текстур, ввод и события.

UI — декларативный интерфейс: экраны, контейнеры, текст, изображения, видео и система стилей.

Все примеры ниже — на JavaScript/TypeScript. Типы приведены для удобства, но API доступен и из чистого JS.

Импорт модулей #

В LeCodes используется ES система модулей:

// 3D/AR

import { Scene, Entity, Mesh, Material, loadGlb } from "creator";

// UI

import { UIScreen, UIButton, UIText, UIImage } from "ui";

Соглашения по типам и единицам #

Векторные/матричные типы используют нотацию из gl-matrix (vec2, vec3, quat, mat4) в виде Float32Array.

Цвета в UI — number (hex, например 0xffcc00) или CSS-строка ("#ffcc00", "rgba(...)").

В асинхронных API используются Promise (например, Texture.load, loadGlb, ARScene.open).

Совместимость платформ #

Один и тот же проект запускается как Web, Instant App (Android) и App Clip (iOS).

Некоторые режимы AR зависят от устройства (например, ARScene с режимом "arcore" требует поддерживаемый Android-девайс). Базовые 3D-функции и UI доступны везде.