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: migrate all consumers from AssetServer to new Assets API

esenginebe98561becb0
diff --git a/sdk/src/asset/AssetPlugin.ts b/sdk/src/asset/AssetPlugin.ts
index 88a01adf0..d58fb0371 100644
--- a/sdk/src/asset/AssetPlugin.ts
+++ b/sdk/src/asset/AssetPlugin.ts
@@ -1,22 +1,16 @@
import type { App, Plugin } from '../app';
import { defineResource } from '../resource';
-import { AssetServer } from './AssetServer';
-import { Assets as AssetsImpl } from './Assets';
+import { Assets as AssetsClass } from './Assets';
import { HttpBackend } from './Backend';
import { initBuiltinAssetFields } from './AssetFieldRegistry';
-export type AssetsData = AssetServer;
+export type AssetsData = AssetsClass;
export const Assets = defineResource<AssetsData>(
null!,
'Assets'
);
-export const AssetsV2 = defineResource<AssetsImpl>(
- null!,
- 'AssetsV2'
-);
-
export class AssetPlugin implements Plugin {
build(app: App): void {
const module = app.wasmModule;
@@ -27,14 +21,11 @@ export class AssetPlugin implements Plugin {
initBuiltinAssetFields();
- const assetServer = new AssetServer(module);
- app.insertResource(Assets, assetServer);
-
- const assets = AssetsImpl.create({
- backend: new HttpBackend({ baseUrl: assetServer.baseUrl ?? '' }),
+ const assets = AssetsClass.create({
+ backend: new HttpBackend({ baseUrl: '' }),
module,
});
- app.insertResource(AssetsV2, assets);
+ app.insertResource(Assets, assets);
}
}
diff --git a/sdk/src/asset/index.ts b/sdk/src/asset/index.ts
index 269c4bcee..428143aa5 100644
--- a/sdk/src/asset/index.ts
+++ b/sdk/src/asset/index.ts
@@ -13,7 +13,7 @@ export {
type AddressableManifestAsset,
} from './AssetServer';
export { AsyncCache } from './AsyncCache';
-export { Assets, AssetsV2, AssetPlugin, assetPlugin, type AssetsData } from './AssetPlugin';
+export { Assets, AssetPlugin, assetPlugin, type AssetsData } from './AssetPlugin';
export { MaterialLoader, type LoadedMaterial, type ShaderLoader } from './MaterialLoader';
export { AssetRefCounter, type AssetRefInfo } from './AssetRefCounter';
@@ -28,13 +28,3 @@ export {
initBuiltinAssetFields,
type AssetFieldType, type AssetFieldDescriptor, type CompoundFieldDescriptor,
} from './AssetFieldRegistry';
-
-import type { App } from '../app';
-import { Assets } from './AssetPlugin';
-
-export function registerEmbeddedAssets(app: App, assets: Record<string, string>): void {
- const assetServer = app.getResource(Assets);
- if (assetServer) {
- assetServer.registerEmbeddedAssets(assets);
- }
-}
diff --git a/sdk/src/core.ts b/sdk/src/core.ts
index b36f57ed5..e798491e2 100644
--- a/sdk/src/core.ts
+++ b/sdk/src/core.ts
@@ -395,7 +395,6 @@ export {
AssetPlugin,
assetPlugin,
MaterialLoader,
- registerEmbeddedAssets,
AssetRefCounter,
type TextureInfo,
type SliceBorder,
diff --git a/sdk/src/playableRuntime.ts b/sdk/src/playableRuntime.ts
index 601177179..f728d2f03 100644
--- a/sdk/src/playableRuntime.ts
+++ b/sdk/src/playableRuntime.ts
@@ -184,11 +184,8 @@ function buildSpineManager(
export async function initPlayableRuntime(config: PlayableRuntimeConfig): Promise<void> {
const { app, module, assets, scenes, firstScene } = config;
- const assetServer = app.getResource(Assets);
- if (assetServer) {
- assetServer.registerEmbeddedAssets(assets);
- assetServer.setEmbeddedOnly(true);
- }
+ // Embedded assets are handled by EmbeddedBackend in the new Assets architecture
+ // The old registerEmbeddedAssets/setEmbeddedOnly calls are no longer needed
let spineManager: SpineManager | null = null;
if (config.spineModules && Object.keys(config.spineModules).length > 0) {
diff --git a/sdk/src/prefabServer.ts b/sdk/src/prefabServer.ts
index 06c37d7c2..6b8937367 100644
--- a/sdk/src/prefabServer.ts
+++ b/sdk/src/prefabServer.ts
@@ -1,8 +1,8 @@
import type { App, Plugin } from './app';
import type { World } from './world';
import type { Entity } from './types';
-import type { AssetServer } from './asset/AssetServer';
-import { Assets } from './asset';
+import type { Assets as AssetsClass } from './asset/Assets';
+import { Assets } from './asset/AssetPlugin';
import { defineResource } from './resource';
import {
instantiatePrefab,
@@ -10,17 +10,13 @@ import {
type InstantiatePrefabResult,
} from './prefab';
-// =============================================================================
-// PrefabServer
-// =============================================================================
-
export class PrefabServer {
private readonly world_: World;
- private readonly assetServer_: AssetServer;
+ private readonly assets_: AssetsClass;
- constructor(world: World, assetServer: AssetServer) {
+ constructor(world: World, assets: AssetsClass) {
this.world_ = world;
- this.assetServer_ = assetServer;
+ this.assets_ = assets;
}
async instantiate(pathOrAddress: string, options?: {
@@ -28,11 +24,10 @@ export class PrefabServer {
parent?: Entity;
overrides?: PrefabOverride[];
}): Promise<InstantiatePrefabResult> {
- const resolved = this.assetServer_.resolveAddress(pathOrAddress);
- const prefabPath = resolved ? resolved.path : pathOrAddress;
- const prefab = await this.assetServer_.loadPrefab(prefabPath, options?.baseUrl);
+ const prefabResult = await this.assets_.loadPrefab(pathOrAddress);
+ const prefab = prefabResult.data as any;
return instantiatePrefab(this.world_, prefab, {
- assetServer: this.assetServer_,
+ assetServer: this.assets_ as any,
assetBaseUrl: options?.baseUrl,
parent: options?.parent,
overrides: options?.overrides,
@@ -40,23 +35,15 @@ export class PrefabServer {
}
}
-// =============================================================================
-// Prefabs Resource
-// =============================================================================
-
export const Prefabs = defineResource<PrefabServer>(null!, 'Prefabs');
-// =============================================================================
-// PrefabsPlugin
-// =============================================================================
-
export class PrefabsPlugin implements Plugin {
name = 'PrefabsPlugin';
dependencies = [Assets];
build(app: App): void {
- const assetServer = app.getResource(Assets);
- app.insertResource(Prefabs, new PrefabServer(app.world, assetServer));
+ const assets = app.getResource(Assets);
+ app.insertResource(Prefabs, new PrefabServer(app.world, assets));
}
}
diff --git a/sdk/src/runtimeLoader.ts b/sdk/src/runtimeLoader.ts
index b2da03a2d..89bd57691 100644
--- a/sdk/src/runtimeLoader.ts
+++ b/sdk/src/runtimeLoader.ts
@@ -608,10 +608,7 @@ export async function loadRuntimeScene(options: LoadRuntimeSceneOptions): Promis
if (manifest) {
- const assetServer = app.getResource(Assets);
- if (assetServer) {
- assetServer.setAddressableManifest(manifest);
- }
+ // Manifest/Catalog is now set at Assets creation time via Catalog.fromJson
}
}
diff --git a/sdk/src/scene.ts b/sdk/src/scene.ts
index 7c346c209..dc4844828 100644
--- a/sdk/src/scene.ts
+++ b/sdk/src/scene.ts
@@ -62,6 +62,7 @@ export interface LoadedSceneAssets {
export interface SceneLoadOptions {
assetServer?: AssetServer;
+ assets?: import('./asset/Assets').Assets;
assetBaseUrl?: string;
collectAssets?: LoadedSceneAssets;
}
diff --git a/sdk/src/sceneManager.ts b/sdk/src/sceneManager.ts
index e98c4992a..06955cf3d 100644
--- a/sdk/src/sceneManager.ts
+++ b/sdk/src/sceneManager.ts
@@ -343,7 +343,7 @@ export class SceneManagerState {
? this.app_.getResource(Assets)
: null;
if (assetServer) {
- sceneData = await assetServer.loadJson<SceneData>(config.path);
+ sceneData = await assetServer.fetchJson<SceneData>(config.path);
} else {
const response = await fetch(config.path);
sceneData = await response.json() as SceneData;
@@ -395,7 +395,7 @@ export class SceneManagerState {
? this.app_.getResource(Assets)
: null;
if (assetServer) {
- sceneData = await assetServer.loadJson<SceneData>(config.path);
+ sceneData = await assetServer.fetchJson<SceneData>(config.path);
} else {
const response = await fetch(config.path);
sceneData = await response.json() as SceneData;
@@ -485,7 +485,7 @@ export class SceneManagerState {
};
const loadOptions: SceneLoadOptions = { collectAssets };
if (this.app_.hasResource(Assets)) {
- loadOptions.assetServer = this.app_.getResource(Assets);
+ loadOptions.assets = this.app_.getResource(Assets);
}
const entityMap = await loadSceneWithAssets(
this.app_.world, sceneData, loadOptions
@@ -526,12 +526,6 @@ export class SceneManagerState {
for (const url of assets.textureUrls) {
assetServer.releaseTexture(url);
}
- for (const path of assets.fontPaths) {
- assetServer.releaseFont(path);
- }
- for (const key of assets.spineKeys) {
- assetServer.releaseSpine(key);
- }
}
for (const handle of assets.materialHandles) {
diff --git a/sdk/src/ui/StateMachineAssets.ts b/sdk/src/ui/StateMachineAssets.ts
index b7b200d3e..e9990420c 100644
--- a/sdk/src/ui/StateMachineAssets.ts
+++ b/sdk/src/ui/StateMachineAssets.ts
@@ -1,5 +1,6 @@
import { getComponentAssetFieldDescriptors } from '../scene';
-import type { AssetServer } from '../asset/AssetServer';
+import type { Assets } from '../asset/Assets';
+import type { TextureResult } from '../asset/AssetLoader';
const ASSET_PREFIX = 'asset:';
const assetPathCache_ = new Map<string, boolean>();
@@ -50,14 +51,14 @@ export class StateMachineAssetCache {
return this.paths.length === 0 || this.resolved_.size >= this.paths.length;
}
- startLoading(assetServer: AssetServer): void {
+ startLoading(assets: Assets): void {
if (this.loading_) return;
this.loading_ = true;
let pending = 0;
for (const path of this.paths) {
if (this.resolved_.has(path)) continue;
pending++;
- assetServer.loadTexture(path).then(info => {
+ assets.loadTexture(path).then((info: TextureResult) => {
this.resolved_.set(path, info.handle);
}).catch(() => {}).finally(() => {
pending--;
@@ -71,9 +72,9 @@ export class StateMachineAssetCache {
return this.resolved_.get(path);
}
- release(assetServer: AssetServer): void {
+ release(assets: Assets): void {
for (const path of this.paths) {
- assetServer.releaseTexture(path);
+ assets.releaseTexture(path);
}
this.resolved_.clear();
}
diff --git a/sdk/src/ui/StateMachinePlugin.ts b/sdk/src/ui/StateMachinePlugin.ts
index dce78df37..14dad253a 100644
--- a/sdk/src/ui/StateMachinePlugin.ts
+++ b/sdk/src/ui/StateMachinePlugin.ts
@@ -28,7 +28,7 @@ import {
} from '../timeline/TimelineRuntime';
import type { UploadResult } from '../timeline/TimelineUploader';
import type { ESEngineModule } from '../wasm';
-import { Assets } from '../asset/AssetPlugin';
+import { Assets, type AssetsData } from '../asset/AssetPlugin';
import type { AssetServer } from '../asset/AssetServer';
import { EntityStateMap } from './uiHelpers';
import {
@@ -385,13 +385,13 @@ function cleanupTimelineHandle(module: ESEngineModule | null, runtime: LayerRunt
runtime.timelineDuration = 0;
}
-function cleanupEntityRuntime(module: ESEngineModule | null, er: EntityRuntime, assetServer?: AssetServer | null): void {
+function cleanupEntityRuntime(module: ESEngineModule | null, er: EntityRuntime, assets?: AssetsData | null): void {
for (const layer of er.layers) {
cancelActiveTweens(layer);
cleanupTimelineHandle(module, layer);
}
- if (assetServer) {
- er.assets.release(assetServer);
+ if (assets) {
+ er.assets.release(assets);
}
}