A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
import type { App, Plugin } from '../app/app';
import { defineSystem, Schedule } from '../ecs/system';
import { Res } from '../ecs/resource';
import { Time, type TimeData } from '../ecs/resource';
import { fxPreviewOrPlayMode } from '../ecs/env';
import type { CppRegistry } from '../wasm';
import { engineApi } from '../ecs/bridge/engineApi';
import { TrailRenderer } from '../ecs/component';
import { Trail, TrailAPI } from './TrailAPI';
export class TrailPlugin implements Plugin {
name = 'trail';
private offDespawn_: (() => void) | null = null;
build(app: App): void {
// `?? {}`: an app with no engine core (a test, a pure-logic host) still gets
// the resource, and every call through it no-ops.
const engine = engineApi(app) ?? {};
const registry = app.world.getCppRegistry() as CppRegistry;
const api = new TrailAPI(engine, registry);
app.insertResource(Trail, api);
// Trail history lives in a C++ side table keyed by entity, not in the
// component — drop it on despawn or the recorded points leak.
this.offDespawn_ = app.world.onDespawn((entity) => {
if (app.world.has(entity, TrailRenderer)) api.clear(entity);
});
// Trail point recording is gameplay — frozen in editor edit mode, runs in
// play mode / standalone runtime (matches particles/animation/physics).
// The FX edit-preview flag is the one authoring exception (env.ts):
// with it on, dragging an entity in the viewport draws its trail live.
app.addSystemToSchedule(Schedule.Update, defineSystem(
[Res(Time), Res(Trail)],
(time: TimeData, trail: TrailAPI) => {
trail.update(time.delta);
},
{ name: 'TrailSystem' }
), { runIf: fxPreviewOrPlayMode });
}
cleanup(): void {
this.offDespawn_?.();
this.offDespawn_ = null;
}
}
export const trailPlugin = new TrailPlugin();