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
/**
* @file TimelineAssetLoader.ts
* @brief Loads a `.estimeline` into the timeline registry, under every ref a
* component may spell it as. Same shape as the anim-clip loader: the
* owner owns the slot, the era owns the textures it resolved.
*/
import type { AssetLoader, LoadContext, TimelineResult, RegistryAssetLoader } from '../AssetLoader';
import type { RegistryEra } from '../registryAssets';
import { parseTimelineAsset, extractTimelineAssetPaths } from '../../timeline/TimelineLoader';
import type { PublishedTimeline } from '../../timeline/TimelineTypes';
import { log } from '../../util/logger';
/** Timelines being prepared right now: a clip that names one of them is a cycle, and waiting on it would never end. */
const preparing = new Set<string>();
export class TimelineAssetLoader implements AssetLoader<TimelineResult> {
readonly type = 'timeline';
readonly extensions = ['.estimeline'];
readonly registry: RegistryAssetLoader<TimelineResult> = {
prepare: async (path: string, ctx: LoadContext): Promise<RegistryEra<TimelineResult>> => {
const text = await ctx.loadText(ctx.catalog.getBuildPath(path));
const asset = parseTimelineAsset(JSON.parse(text));
const textureHandles = new Map<string, number>();
// The timelines its sequence clips play must be resolvable when it runs. One that is already being
// prepared further up is a cycle: left out, and the player skips it the same way.
preparing.add(path);
try {
for (const ref of extractTimelineAssetPaths(asset).timelines) {
if (preparing.has(ctx.resolveRef?.(ref) ?? ref)) {
log.warn('asset', `${path}: a sequence clip plays ${ref}, which is already playing this timeline — skipped`);
continue;
}
try {
await ctx.acquireAsset('timeline', ref);
} catch (e) {
log.warn('asset', `${path}: failed to load the sequence ${ref}`, e);
}
}
} finally {
preparing.delete(path);
}
for (const texPath of extractTimelineAssetPaths(asset).textures) {
try {
const lease = await ctx.acquireTexture(texPath, true);
textureHandles.set(texPath, lease.value.handle);
} catch (e) {
log.warn('asset', `Failed to load texture: ${texPath}`, e);
textureHandles.set(texPath, 0);
}
}
const published: PublishedTimeline = { asset, textureHandles };
return { published, value: { timelineId: path } };
},
// Nothing: the slot holds the era, and the timeline system reads it
// there. A module-level "active registry" answered with whichever app
// built its plugin last.
};
}