Skip to content

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.

refactor: add plugin dependency declarations and topological sort

esengine070697ffbf2c
diff --git a/sdk/src/animation/AnimationPlugin.ts b/sdk/src/animation/AnimationPlugin.ts
index a154005de..0bda7b62d 100644
--- a/sdk/src/animation/AnimationPlugin.ts
+++ b/sdk/src/animation/AnimationPlugin.ts
@@ -13,7 +13,7 @@ import { spriteAnimatorSystemUpdate } from './SpriteAnimator';
import { isEditor, isPlayMode } from '../env';
export class AnimationPlugin implements Plugin {
- name = 'AnimationPlugin';
+ name = 'animation';
build(app: App): void {
const module = app.wasmModule as ESEngineModule;
diff --git a/sdk/src/app.ts b/sdk/src/app.ts
index 8d25fb45a..e26d3ebc2 100644
--- a/sdk/src/app.ts
+++ b/sdk/src/app.ts
@@ -108,6 +108,14 @@ export class App {
return this.installed_plugins_.find((p): p is T => p instanceof ctor);
}
+ addPlugins(plugins: Plugin[]): this {
+ const sorted = this.sortPlugins(plugins);
+ for (const plugin of sorted) {
+ this.addPlugin(plugin);
+ }
+ return this;
+ }
+
addPlugin(plugin: Plugin): this {
if (this.installedPluginSet_.has(plugin)) return this;
if (plugin.dependencies) {
@@ -538,6 +546,46 @@ export class App {
}
}
+ private sortPlugins(plugins: Plugin[]): Plugin[] {
+ if (plugins.length <= 1) return plugins;
+
+ const nameToIndex = new Map<string, number>();
+ for (let i = 0; i < plugins.length; i++) {
+ const name = plugins[i].name;
+ if (name) nameToIndex.set(name, i);
+ }
+
+ const sorted: Plugin[] = [];
+ const visited = new Set<number>();
+ const visiting = new Set<number>();
+
+ const visit = (index: number): void => {
+ if (visited.has(index)) return;
+ if (visiting.has(index)) {
+ throw new Error(`Circular plugin dependency detected involving "${plugins[index].name ?? index}"`);
+ }
+ visiting.add(index);
+ const deps = plugins[index].dependencies;
+ if (deps) {
+ for (const dep of deps) {
+ if (typeof dep !== 'string') continue;
+ const depIndex = nameToIndex.get(dep);
+ if (depIndex !== undefined) {
+ visit(depIndex);
+ }
+ }
+ }
+ visiting.delete(index);
+ visited.add(index);
+ sorted.push(plugins[index]);
+ };
+
+ for (let i = 0; i < plugins.length; i++) {
+ visit(i);
+ }
+ return sorted;
+ }
+
private sortSystems(systems: SystemEntry[]): SystemEntry[] {
if (systems.length <= 1) {
return systems;
@@ -805,9 +853,7 @@ export function createWebApp(module: ESEngineModule, options?: WebAppOptions): A
app.addPlugin(inputPlugin);
app.addPlugin(sceneManagerPlugin);
if (options?.plugins) {
- for (const plugin of options.plugins) {
- app.addPlugin(plugin);
- }
+ app.addPlugins(options.plugins);
}
return app;
diff --git a/sdk/src/asset/AssetPlugin.ts b/sdk/src/asset/AssetPlugin.ts
index d58fb0371..522230409 100644
--- a/sdk/src/asset/AssetPlugin.ts
+++ b/sdk/src/asset/AssetPlugin.ts
@@ -12,6 +12,8 @@ export const Assets = defineResource<AssetsData>(
);
export class AssetPlugin implements Plugin {
+ name = 'asset';
+
build(app: App): void {
const module = app.wasmModule;
if (!module) {
diff --git a/sdk/src/audio/AudioPlugin.ts b/sdk/src/audio/AudioPlugin.ts
index ea25d7f29..18b6c2d93 100644
--- a/sdk/src/audio/AudioPlugin.ts
+++ b/sdk/src/audio/AudioPlugin.ts
@@ -18,7 +18,7 @@ export interface AudioPluginConfig {
}
export class AudioPlugin implements Plugin {
- name = 'AudioPlugin';
+ name = 'audio';
private config_: AudioPluginConfig;
private activeSourceHandles_: Map<number, AudioHandle> | null = null;
private playedEntities_: Set<number> | null = null;
diff --git a/sdk/src/corePlugin.ts b/sdk/src/corePlugin.ts
index d198d829d..136bbbe37 100644
--- a/sdk/src/corePlugin.ts
+++ b/sdk/src/corePlugin.ts
@@ -9,7 +9,7 @@ import { initRendererAPI, shutdownRendererAPI } from './renderer';
import { initGLDebugAPI, shutdownGLDebugAPI } from './glDebug';
export const corePlugin: Plugin = {
- name: 'EngineCore',
+ name: 'engineCore',
build(app) {
const module = app.wasmModule!;
diff --git a/sdk/src/input.ts b/sdk/src/input.ts
index 58bec6b0a..5e94d4512 100644
--- a/sdk/src/input.ts
+++ b/sdk/src/input.ts
@@ -51,6 +51,7 @@ export class InputState {
export const Input = defineResource<InputState>(new InputState(), 'Input');
export class InputPlugin implements Plugin {
+ name = 'input';
private target_: unknown;
constructor(target?: unknown) {
diff --git a/sdk/src/particle/ParticlePlugin.ts b/sdk/src/particle/ParticlePlugin.ts
index 93b516b57..bd78fd3bf 100644
--- a/sdk/src/particle/ParticlePlugin.ts
+++ b/sdk/src/particle/ParticlePlugin.ts
@@ -6,7 +6,7 @@ import type { ESEngineModule, CppRegistry } from '../wasm';
import { initParticleAPI, shutdownParticleAPI, Particle } from './ParticleAPI';
export class ParticlePlugin implements Plugin {
- name = 'ParticlePlugin';
+ name = 'particle';
build(app: App): void {
const module = app.wasmModule as ESEngineModule;
diff --git a/sdk/src/physics/PhysicsPlugin.ts b/sdk/src/physics/PhysicsPlugin.ts
index 847d4e29e..b0e26679e 100644
--- a/sdk/src/physics/PhysicsPlugin.ts
+++ b/sdk/src/physics/PhysicsPlugin.ts
@@ -122,6 +122,7 @@ function readPixelsPerUnit(app: App): number {
}
export class PhysicsPlugin implements Plugin {
+ name = 'physics';
private config_: Required<Omit<PhysicsPluginConfig, 'collisionLayerMasks'>> & Pick<PhysicsPluginConfig, 'collisionLayerMasks'>;
private wasmUrl_: string;
private factory_?: PhysicsModuleFactory;
diff --git a/sdk/src/postprocess/PostProcessPlugin.ts b/sdk/src/postprocess/PostProcessPlugin.ts
index 4ca8d496d..e515cbd37 100644
--- a/sdk/src/postprocess/PostProcessPlugin.ts
+++ b/sdk/src/postprocess/PostProcessPlugin.ts
@@ -5,7 +5,7 @@ import { cleanupAllPostProcessVolumes } from './sync';
import { postProcessVolumeSystem, cleanupVolumeSystem, PostProcessVolumeConfigResource } from './volumeSystem';
export class PostProcessPlugin implements Plugin {
- name = 'PostProcessPlugin';
+ name = 'postProcess';
build(app: App): void {
app.insertResource(PostProcessVolumeConfigResource, { enabled: true });
diff --git a/sdk/src/prefabServer.ts b/sdk/src/prefabServer.ts
index 8aae8ef61..85efde3d0 100644
--- a/sdk/src/prefabServer.ts
+++ b/sdk/src/prefabServer.ts
@@ -39,7 +39,7 @@ export class PrefabServer {
export const Prefabs = defineResource<PrefabServer>(null!, 'Prefabs');
export class PrefabsPlugin implements Plugin {
- name = 'PrefabsPlugin';
+ name = 'prefabs';
dependencies = [Assets];
build(app: App): void {
diff --git a/sdk/src/preview/PreviewPlugin.ts b/sdk/src/preview/PreviewPlugin.ts
index 20f02eb99..80d4bbb05 100644
--- a/sdk/src/preview/PreviewPlugin.ts
+++ b/sdk/src/preview/PreviewPlugin.ts
@@ -20,6 +20,7 @@ const PREVIEW_SCENE = '__preview__';
// =============================================================================
export class PreviewPlugin implements Plugin {
+ name = 'preview';
private sceneUrl_: string;
private baseUrl_: string;
private app_: App | null = null;
diff --git a/sdk/src/scenePlugin.ts b/sdk/src/scenePlugin.ts
index 8c3b1ca39..fa999f252 100644
--- a/sdk/src/scenePlugin.ts
+++ b/sdk/src/scenePlugin.ts
@@ -19,7 +19,7 @@ const sceneTransitionSystem = defineSystem(
);
export const sceneManagerPlugin: Plugin = {
- name: 'SceneManager',
+ name: 'sceneManager',
build(app: App): void {
const state = new SceneManagerState(app);
app.insertResource(SceneManager, state);
diff --git a/sdk/src/spine/SpinePlugin.ts b/sdk/src/spine/SpinePlugin.ts
index 7a3f45c2f..bf2d89fe8 100644
--- a/sdk/src/spine/SpinePlugin.ts
+++ b/sdk/src/spine/SpinePlugin.ts
@@ -38,6 +38,7 @@ const SPINE_TYPE_MAP: Record<number, SpineEventType | null> = {
};
export class SpinePlugin implements Plugin {
+ name = 'spine';
private spineManager_: SpineManager | null;
private provider_: SpineWasmProvider | null;
private app_: App | null = null;
diff --git a/sdk/src/stats.ts b/sdk/src/stats.ts
index d16245eb2..b0212830d 100644
--- a/sdk/src/stats.ts
+++ b/sdk/src/stats.ts
@@ -153,7 +153,7 @@ export interface StatsPluginOptions {
}
export class StatsPlugin implements Plugin {
- readonly name = 'Stats';
+ readonly name = 'stats';
private collector_ = new StatsCollector();
private overlay_: StatsOverlay | null = null;
private options_: StatsPluginOptions;
diff --git a/sdk/src/tilemap/tilemapPlugin.ts b/sdk/src/tilemap/tilemapPlugin.ts
index d284db35f..004bf1db4 100644
--- a/sdk/src/tilemap/tilemapPlugin.ts
+++ b/sdk/src/tilemap/tilemapPlugin.ts
@@ -19,7 +19,7 @@ const GRID_TYPE_MAP: Record<string, number> = {
};
export class TilemapPlugin implements Plugin {
- name = 'TilemapPlugin';
+ name = 'tilemap';
private initializedLayers_ = new Set<number>();
private animatedLayers_ = new Set<number>();
diff --git a/sdk/src/timeline/TimelinePlugin.ts b/sdk/src/timeline/TimelinePlugin.ts
index 340e4f4eb..b236db81b 100644
--- a/sdk/src/timeline/TimelinePlugin.ts
+++ b/sdk/src/timeline/TimelinePlugin.ts
@@ -65,7 +65,7 @@ interface AnimFramesState {
}
export class TimelinePlugin implements Plugin {
- name = 'TimelinePlugin';
+ name = 'timeline';
private handles_ = new Map<number, UploadResult>();
private animFramesStates_ = new Map<number, AnimFramesState>();
diff --git a/sdk/src/ui/CollectionViewPlugin.ts b/sdk/src/ui/CollectionViewPlugin.ts
index ded1dc5fa..754d34e2e 100644
--- a/sdk/src/ui/CollectionViewPlugin.ts
+++ b/sdk/src/ui/CollectionViewPlugin.ts
@@ -30,6 +30,9 @@ export function getCollectionState(entity: Entity): CollectionState | null {
}
export class CollectionViewPlugin implements Plugin {
+ name = 'collectionView';
+ dependencies = ['uiLayout'];
+
private cleanup_: (() => void) | null = null;
build(app: App): void {
diff --git a/sdk/src/ui/DataBindingPlugin.ts b/sdk/src/ui/DataBindingPlugin.ts
index 5e2f48e74..af4a66b47 100644
--- a/sdk/src/ui/DataBindingPlugin.ts
+++ b/sdk/src/ui/DataBindingPlugin.ts
@@ -17,6 +17,8 @@ function getCachedComponentDef(name: string): AnyComponentDef | null {
}
export class DataBindingPlugin implements Plugin {
+ name = 'dataBinding';
+
build(app: App): void {
registerComponent('DataBinding', DataBinding);
diff --git a/sdk/src/ui/DragPlugin.ts b/sdk/src/ui/DragPlugin.ts
index cd0256025..76cc8511c 100644
--- a/sdk/src/ui/DragPlugin.ts
+++ b/sdk/src/ui/DragPlugin.ts
@@ -70,6 +70,9 @@ function applyConstraints(
}
export class DragPlugin implements Plugin {
+ name = 'drag';
+ dependencies = ['uiInteraction'];
+
build(app: App): void {
registerComponent('Draggable', Draggable);
registerComponent('DragState', DragState);
diff --git a/sdk/src/ui/DropdownPlugin.ts b/sdk/src/ui/DropdownPlugin.ts
index e5ccc8863..39bcb1966 100644
--- a/sdk/src/ui/DropdownPlugin.ts
+++ b/sdk/src/ui/DropdownPlugin.ts
@@ -31,6 +31,8 @@ interface DropdownState {
}
export class DropdownPlugin implements Plugin {
+ name = 'dropdown';
+
private cleanup_: (() => void) | null = null;
cleanup(): void {
diff --git a/sdk/src/ui/FanLayoutPlugin.ts b/sdk/src/ui/FanLayoutPlugin.ts
index f49c63a77..ad7247f04 100644
--- a/sdk/src/ui/FanLayoutPlugin.ts
+++ b/sdk/src/ui/FanLayoutPlugin.ts
@@ -3,6 +3,8 @@ import { registerComponent } from '../component';
import { FanLayout } from './layouts/FanLayout';
export class FanLayoutPlugin implements Plugin {
+ name = 'fanLayout';
+
build(_app: App): void {
registerComponent('FanLayout', FanLayout);
}
diff --git a/sdk/src/ui/FocusPlugin.ts b/sdk/src/ui/FocusPlugin.ts
index 253e00f21..681e77bc8 100644
--- a/sdk/src/ui/FocusPlugin.ts
+++ b/sdk/src/ui/FocusPlugin.ts
@@ -15,6 +15,8 @@ import { isEditor, isPlayMode } from '../env';
import { UIEvents, UIEventQueue } from './UIEvents';
export class FocusPlugin implements Plugin {
+ name = 'focus';
+
build(app: App): void {
registerComponent('Focusable', Focusable);
diff --git a/sdk/src/ui/GridLayoutPlugin.ts b/sdk/src/ui/GridLayoutPlugin.ts
index 5787b7357..fce28660b 100644
--- a/sdk/src/ui/GridLayoutPlugin.ts
+++ b/sdk/src/ui/GridLayoutPlugin.ts
@@ -3,6 +3,8 @@ import { registerComponent } from '../component';
import { GridLayout } from './layouts/GridLayout';
export class GridLayoutPlugin implements Plugin {
+ name = 'gridLayout';
+
build(_app: App): void {
registerComponent('GridLayout', GridLayout);
}
diff --git a/sdk/src/ui/ImagePlugin.ts b/sdk/src/ui/ImagePlugin.ts
index 792974734..6fba95aa7 100644
--- a/sdk/src/ui/ImagePlugin.ts
+++ b/sdk/src/ui/ImagePlugin.ts
@@ -26,6 +26,8 @@ function ensureUIRenderer(world: import('../world').World, entity: Entity): void
}
export class ImagePlugin implements Plugin {
+ name = 'image';
+
build(app: App): void {
registerComponent('Image', Image);
diff --git a/sdk/src/ui/LayoutGroupPlugin.ts b/sdk/src/ui/LayoutGroupPlugin.ts
index 61809032a..a747a897b 100644
--- a/sdk/src/ui/LayoutGroupPlugin.ts
+++ b/sdk/src/ui/LayoutGroupPlugin.ts
@@ -3,6 +3,9 @@ import { registerComponent } from '../component';
import { LayoutGroup } from './LayoutGroup';
export class LayoutGroupPlugin implements Plugin {
+ name = 'layoutGroup';
+ dependencies = ['uiLayout'];
+
build(_app: App): void {
registerComponent('LayoutGroup', LayoutGroup);
}
diff --git a/sdk/src/ui/LinearLayoutPlugin.ts b/sdk/src/ui/LinearLayoutPlugin.ts
index 4539eb831..e3ac807ba 100644
--- a/sdk/src/ui/LinearLayoutPlugin.ts
+++ b/sdk/src/ui/LinearLayoutPlugin.ts
@@ -3,6 +3,8 @@ import { registerComponent } from '../component';
import { LinearLayout } from './layouts/LinearLayout';
export class LinearLayoutPlugin implements Plugin {
+ name = 'linearLayout';
+
build(_app: App): void {
registerComponent('LinearLayout', LinearLayout);
}
diff --git a/sdk/src/ui/ProgressBarPlugin.ts b/sdk/src/ui/ProgressBarPlugin.ts
index f12281acc..9bc6d9692 100644
--- a/sdk/src/ui/ProgressBarPlugin.ts
+++ b/sdk/src/ui/ProgressBarPlugin.ts
@@ -8,6 +8,8 @@ import type { ProgressBarData } from './ProgressBar';
import { applyDirectionalFill, withChildEntity } from './uiHelpers';
export class ProgressBarPlugin implements Plugin {
+ name = 'progressBar';
+
build(app: App): void {
registerComponent('ProgressBar', ProgressBar);
diff --git a/sdk/src/ui/SafeAreaPlugin.ts b/sdk/src/ui/SafeAreaPlugin.ts
index af38b101b..08051b7c0 100644
--- a/sdk/src/ui/SafeAreaPlugin.ts
+++ b/sdk/src/ui/SafeAreaPlugin.ts
@@ -60,6 +60,8 @@ function getSafeAreaInsets(): SafeAreaInsets {
}
export class SafeAreaPlugin implements Plugin {
+ name = 'safeArea';
+
build(app: App): void {
registerComponent('SafeArea', SafeArea);
diff --git a/sdk/src/ui/ScrollViewPlugin.ts b/sdk/src/ui/ScrollViewPlugin.ts
index 9d804fc33..8be9284f9 100644
--- a/sdk/src/ui/ScrollViewPlugin.ts
+++ b/sdk/src/ui/ScrollViewPlugin.ts
@@ -68,6 +68,9 @@ interface ScrollState {
}
export class ScrollViewPlugin implements Plugin {
+ name = 'scrollView';
+ dependencies = ['uiLayout'];
+
private cleanup_: (() => void) | null = null;
cleanup(): void {
diff --git a/sdk/src/ui/SelectablePlugin.ts b/sdk/src/ui/SelectablePlugin.ts
index 709b4d049..2e4e5babb 100644
--- a/sdk/src/ui/SelectablePlugin.ts
+++ b/sdk/src/ui/SelectablePlugin.ts
@@ -9,6 +9,8 @@ import { Selectable, type SelectableData } from './Selectable';
import { UIEvents, UIEventQueue } from './UIEvents';
export class SelectablePlugin implements Plugin {
+ name = 'selectable';
+
build(app: App): void {
const world = app.world;
diff --git a/sdk/src/ui/SliderPlugin.ts b/sdk/src/ui/SliderPlugin.ts
index b8b3043b4..463d5df8e 100644
--- a/sdk/src/ui/SliderPlugin.ts
+++ b/sdk/src/ui/SliderPlugin.ts
@@ -79,6 +79,8 @@ function syncHandleRect(
}
export class SliderPlugin implements Plugin {
+ name = 'slider';
+
build(app: App): void {
registerComponent('Slider', Slider);
diff --git a/sdk/src/ui/StateMachinePlugin.ts b/sdk/src/ui/StateMachinePlugin.ts
index 14dad253a..0a21d5d88 100644
--- a/sdk/src/ui/StateMachinePlugin.ts
+++ b/sdk/src/ui/StateMachinePlugin.ts
@@ -494,6 +494,8 @@ function processLayer(
}
export class StateMachinePlugin implements Plugin {
+ name = 'stateMachine';
+
build(app: App): void {
registerComponent('StateMachine', StateMachine);
diff --git a/sdk/src/ui/TextInputPlugin.ts b/sdk/src/ui/TextInputPlugin.ts
index 79f14b502..1215c014d 100644
--- a/sdk/src/ui/TextInputPlugin.ts
+++ b/sdk/src/ui/TextInputPlugin.ts
@@ -19,6 +19,8 @@ import { wrapText, nextPowerOf2, ensureComponent, colorToRgba } from './uiHelper
import { CURSOR_BLINK_INTERVAL, TEXT_INPUT_LINE_HEIGHT_RATIO } from './uiConstants';
export class TextInputPlugin implements Plugin {
+ name = 'textInput';
+
private cleanupListeners_: (() => void) | null = null;
cleanup(): void {
diff --git a/sdk/src/ui/TextPlugin.ts b/sdk/src/ui/TextPlugin.ts
index baab22e46..3b27778a4 100644
--- a/sdk/src/ui/TextPlugin.ts
+++ b/sdk/src/ui/TextPlugin.ts
@@ -27,6 +27,9 @@ function ensureUIRenderer(world: import('../world').World, entity: Entity): void
}
export class TextPlugin implements Plugin {
+ name = 'text';
+ dependencies = ['uiLayout'];
+
build(app: App): void {
registerComponent('Text', Text);
diff --git a/sdk/src/ui/TogglePlugin.ts b/sdk/src/ui/TogglePlugin.ts
index 6224c0903..f05c76ecf 100644
--- a/sdk/src/ui/TogglePlugin.ts
+++ b/sdk/src/ui/TogglePlugin.ts
@@ -34,6 +34,8 @@ function setRendererEnabled(world: import('../world').World, entity: Entity, ena
}
export class TogglePlugin implements Plugin {
+ name = 'toggle';
+
build(app: App): void {
registerComponent('Toggle', Toggle);
registerComponent('ToggleGroup', ToggleGroup);
diff --git a/sdk/src/ui/UIInteractionPlugin.ts b/sdk/src/ui/UIInteractionPlugin.ts
index e64e988eb..6114da813 100644
--- a/sdk/src/ui/UIInteractionPlugin.ts
+++ b/sdk/src/ui/UIInteractionPlugin.ts
@@ -49,6 +49,9 @@ function emitWithBubbling(
}
export class UIInteractionPlugin implements Plugin {
+ name = 'uiInteraction';
+ dependencies = ['uiLayout'];
+
build(app: App): void {
registerComponent('Interactable', Interactable);
registerComponent('Button', Button);
diff --git a/sdk/src/ui/UILayoutPlugin.ts b/sdk/src/ui/UILayoutPlugin.ts
index 2d5091ecb..c92d7267a 100644
--- a/sdk/src/ui/UILayoutPlugin.ts
+++ b/sdk/src/ui/UILayoutPlugin.ts
@@ -13,6 +13,8 @@ import type { CppRegistry } from '../wasm';
import { initUIHelpers } from './uiHelpers';
export class UILayoutPlugin implements Plugin {
+ name = 'uiLayout';
+
build(app: App): void {
registerComponent('UIRect', UIRect);
registerComponent('UIRenderer', UIRenderer);
diff --git a/sdk/src/ui/UIMaskPlugin.ts b/sdk/src/ui/UIMaskPlugin.ts
index adb8a2041..8667a6189 100644
--- a/sdk/src/ui/UIMaskPlugin.ts
+++ b/sdk/src/ui/UIMaskPlugin.ts
@@ -3,6 +3,8 @@ import { registerComponent } from '../component';
import { UIMask } from './UIMask';
export class UIMaskPlugin implements Plugin {
+ name = 'uiMask';
+
build(app: App): void {
registerComponent('UIMask', UIMask);
}
diff --git a/sdk/src/ui/UIRenderOrderPlugin.ts b/sdk/src/ui/UIRenderOrderPlugin.ts
index fe11f9e0b..291c9292c 100644
--- a/sdk/src/ui/UIRenderOrderPlugin.ts
+++ b/sdk/src/ui/UIRenderOrderPlugin.ts
@@ -3,6 +3,9 @@ import { defineSystem, Schedule } from '../system';
import type { ESEngineModule, CppRegistry } from '../wasm';
export class UIRenderOrderPlugin implements Plugin {
+ name = 'uiRenderOrder';
+ dependencies = ['uiLayout', 'collectionView'];
+
build(app: App): void {
const world = app.world;
const module = app.wasmModule as ESEngineModule;