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 TimelinePlayerComponent.ts
* @brief What plays a timeline on an entity: the component, and the one rule
* for reading its wrap mode.
*
* @details Separate from the plugin that advances it because it is DATA — the
* plugin, the animator's timeline motion, and the AI conditions all
* read this shape, and a component living inside the system that ticks
* it makes every other reader depend on that system.
*/
import { defineComponent } from '../ecs/component';
import { wrapModeFromName, isWrapModeName, type WrapMode } from './TimelineTypes';
export interface TimelinePlayerData {
timeline: string;
playing: boolean;
speed: number;
/** Overrides the wrap mode the CLIP declares; empty means the clip's own. */
wrapMode: string;
/**
* Latched true when a Once clip completes; cleared when `playing` is raised
* again (which replays from the top). Runtime-observable — don't author it.
*/
finished: boolean;
}
/**
* Which wrap mode a playing clip runs under: the CLIP's, unless the player names
* one to override it with. A string that is not a wrap mode name is a typo, not
* a choice, and leaves the clip's own mode standing.
*/
export function resolveWrapMode(playerWrapMode: string, assetWrapMode: WrapMode): WrapMode {
return isWrapModeName(playerWrapMode) ? wrapModeFromName(playerWrapMode) : assetWrapMode;
}
export const TimelinePlayer = /* @__PURE__ */ defineComponent<TimelinePlayerData>('TimelinePlayer', {
timeline: '',
playing: false,
speed: 1.0,
wrapMode: '',
finished: false,
}, {
assetFields: [{ field: 'timeline', type: 'timeline' }],
fields: {
wrapMode: { tooltip: "Override the clip's own wrap mode: once, loop or pingPong. Empty uses what the clip declares." },
finished: { advanced: true, tooltip: 'Clip completed (runtime, read-only). Raise Playing to replay.' },
},
});