@needle-tools/engine 5.1.0-canary.c111c4f → 5.1.0-canary.cce79c8

package/lib/engine-components/timeline/TimelineBuilder.js

@@ -0,0 +1,400 @@
+import { GameObject } from "../Component.js";
+import { InstantiateIdProvider } from "../../engine/engine_networking_instantiate.js";
+import { EventList } from "../EventList.js";
+import { SignalAsset, SignalReceiver, SignalReceiverEvent } from "./SignalAsset.js";
+import { ClipExtrapolation, TrackType } from "./TimelineModels.js";
+import { MarkerType } from "./TimelineModels.js";
+/**
+ * A fluent builder for creating timeline assets ({@link TimelineAssetModel}) from code.
+ *
+ * Use {@link TimelineBuilder.create} to start building a timeline.
+ *
+ * @example Using build() for timelines without signal callbacks
+ * ```ts
+ * const timeline = TimelineBuilder.create("MySequence")
+ *     .animationTrack("Character", animator)
+ *         .clip(walkClip, { duration: 2, easeIn: 0.3 })
+ *         .clip(runClip, { duration: 3, easeIn: 0.5, easeOut: 0.5 })
+ *     .activationTrack("FX", particleObject)
+ *         .clip({ start: 1, duration: 2 })
+ *     .audioTrack("Music", audioSource)
+ *         .clip("music.mp3", { start: 0, duration: 5, volume: 0.8 })
+ *     .build();
+ *
+ * director.playableAsset = timeline;
+ * director.play();
+ * ```
+ *
+ * @example Using install() with signal callbacks
+ * ```ts
+ * TimelineBuilder.create("WithSignals")
+ *     .animationTrack("Character", animator)
+ *         .clip(walkClip, { duration: 2 })
+ *     .signalTrack("Events")
+ *         .signal(1.0, () => console.log("1 second!"))
+ *         .signal(2.0, () => spawnParticles())
+ *     .install(director);
+ *
+ * director.play();
+ * ```
+ *
+ * @category Animation and Sequencing
+ * @group Utilities
+ */
+export class TimelineBuilder {
+    _name;
+    _tracks = [];
+    _currentTrack = null;
+    _pendingSignals = [];
+    _idProvider;
+    constructor(name, seed) {
+        this._name = name;
+        this._idProvider = new InstantiateIdProvider(seed ?? Date.now());
+    }
+    /**
+     * Creates a new TimelineBuilder instance.
+     * @param name - Name for the timeline asset
+     * @param seed - Optional numeric seed for deterministic guid generation. Defaults to `Date.now()`.
+     */
+    static create(name, seed) {
+        return new TimelineBuilder(name ?? "Timeline", seed);
+    }
+    // #region Track creation
+    /**
+     * Adds an animation track. Subsequent `.clip()` calls add animation clips to this track.
+     * @param name - Display name for the track
+     * @param binding - The Animator or Object3D to animate
+     */
+    animationTrack(name, binding) {
+        this._currentTrack = this.pushTrack(name, TrackType.Animation, binding ?? null);
+        return this;
+    }
+    /**
+     * Adds an audio track. Subsequent `.clip()` calls add audio clips to this track.
+     * @param name - Display name for the track
+     * @param binding - The AudioSource to play audio on (optional)
+     * @param volume - Track volume multiplier (default: 1)
+     */
+    audioTrack(name, binding, volume) {
+        this._currentTrack = this.pushTrack(name, TrackType.Audio, binding ?? null);
+        this._currentTrack.volume = volume;
+        return this;
+    }
+    /**
+     * Adds an activation track. Subsequent `.clip()` calls define when the bound object is active.
+     * @param name - Display name for the track
+     * @param binding - The Object3D to show/hide
+     */
+    activationTrack(name, binding) {
+        this._currentTrack = this.pushTrack(name, TrackType.Activation, binding ?? null);
+        return this;
+    }
+    /**
+     * Adds a control track. Subsequent `.clip()` calls control nested timelines or objects.
+     * @param name - Display name for the track
+     */
+    controlTrack(name) {
+        this._currentTrack = this.pushTrack(name, TrackType.Control, null);
+        return this;
+    }
+    /**
+     * Adds a signal track. Use `.signal()` or `.marker()` to add signal markers.
+     * @param name - Display name for the track
+     * @param binding - The SignalReceiver component (optional — if using `.signal()` with callbacks, one is created automatically by {@link install})
+     */
+    signalTrack(name, binding) {
+        this._currentTrack = this.pushTrack(name, TrackType.Signal, binding ?? null);
+        return this;
+    }
+    /**
+     * Adds a marker track. Use `.marker()` to add markers.
+     * @param name - Display name for the track
+     */
+    markerTrack(name) {
+        this._currentTrack = this.pushTrack(name, TrackType.Marker, null);
+        return this;
+    }
+    clip(assetOrOptions, options) {
+        if (!this._currentTrack)
+            throw new Error("TimelineBuilder: .clip() must be called after a track method (e.g. .animationTrack())");
+        const track = this._currentTrack;
+        switch (track.type) {
+            case TrackType.Animation: {
+                const animClip = assetOrOptions;
+                const opts = (options ?? {});
+                const duration = opts.duration ?? animClip.duration;
+                const start = opts.start ?? track.cursor;
+                const end = start + duration;
+                const clipModel = {
+                    start,
+                    end,
+                    duration,
+                    timeScale: opts.speed ?? 1,
+                    clipIn: opts.clipIn ?? 0,
+                    easeInDuration: opts.easeIn ?? 0,
+                    easeOutDuration: opts.easeOut ?? 0,
+                    preExtrapolationMode: opts.preExtrapolation ?? ClipExtrapolation.None,
+                    postExtrapolationMode: opts.postExtrapolation ?? ClipExtrapolation.None,
+                    reversed: opts.reversed,
+                    asset: {
+                        clip: animClip,
+                        loop: opts.loop ?? false,
+                        duration: animClip.duration,
+                        removeStartOffset: opts.removeStartOffset ?? false,
+                    },
+                };
+                track.clips.push(clipModel);
+                track.cursor = end;
+                break;
+            }
+            case TrackType.Audio: {
+                const url = assetOrOptions;
+                const opts = (options ?? {});
+                const duration = opts.duration;
+                const start = opts.start ?? track.cursor;
+                const end = start + duration;
+                const clipModel = {
+                    start,
+                    end,
+                    duration,
+                    timeScale: opts.speed ?? 1,
+                    clipIn: 0,
+                    easeInDuration: opts.easeIn ?? 0,
+                    easeOutDuration: opts.easeOut ?? 0,
+                    preExtrapolationMode: ClipExtrapolation.None,
+                    postExtrapolationMode: ClipExtrapolation.None,
+                    asset: {
+                        clip: url,
+                        loop: opts.loop ?? false,
+                        volume: opts.volume ?? 1,
+                    },
+                };
+                track.clips.push(clipModel);
+                track.cursor = end;
+                break;
+            }
+            case TrackType.Activation: {
+                const opts = assetOrOptions;
+                const start = opts.start ?? track.cursor;
+                const end = start + opts.duration;
+                const clipModel = {
+                    start,
+                    end,
+                    duration: opts.duration,
+                    timeScale: 1,
+                    clipIn: 0,
+                    easeInDuration: opts.easeIn ?? 0,
+                    easeOutDuration: opts.easeOut ?? 0,
+                    preExtrapolationMode: ClipExtrapolation.None,
+                    postExtrapolationMode: ClipExtrapolation.None,
+                    asset: {},
+                };
+                track.clips.push(clipModel);
+                track.cursor = end;
+                break;
+            }
+            case TrackType.Control: {
+                const sourceObject = assetOrOptions;
+                const opts = (options ?? {});
+                const start = opts.start ?? track.cursor;
+                const duration = opts.duration;
+                const end = start + duration;
+                const clipModel = {
+                    start,
+                    end,
+                    duration,
+                    timeScale: 1,
+                    clipIn: 0,
+                    easeInDuration: 0,
+                    easeOutDuration: 0,
+                    preExtrapolationMode: ClipExtrapolation.None,
+                    postExtrapolationMode: ClipExtrapolation.None,
+                    asset: {
+                        sourceObject,
+                        controlActivation: opts.controlActivation ?? true,
+                        updateDirector: opts.updateDirector ?? true,
+                    },
+                };
+                track.clips.push(clipModel);
+                track.cursor = end;
+                break;
+            }
+            default:
+                throw new Error(`TimelineBuilder: .clip() is not supported on track type "${track.type}"`);
+        }
+        return this;
+    }
+    /**
+     * Adds a signal marker to the current signal or marker track.
+     * @param time - Time in seconds when the signal fires
+     * @param asset - The signal asset identifier (guid string)
+     * @param options - Optional marker configuration
+     */
+    marker(time, asset, options) {
+        if (!this._currentTrack)
+            throw new Error("TimelineBuilder: .marker() must be called after a track method");
+        if (this._currentTrack.type !== TrackType.Signal && this._currentTrack.type !== TrackType.Marker) {
+            throw new Error(`TimelineBuilder: .marker() is only supported on signal and marker tracks, not "${this._currentTrack.type}"`);
+        }
+        const marker = {
+            type: MarkerType.Signal,
+            time,
+            retroActive: options?.retroActive ?? false,
+            emitOnce: options?.emitOnce ?? false,
+            asset,
+        };
+        this._currentTrack.markers.push(marker);
+        // Update cursor past the marker
+        if (time > this._currentTrack.cursor) {
+            this._currentTrack.cursor = time;
+        }
+        return this;
+    }
+    /**
+     * Adds a signal with a callback to the current signal track.
+     * This is a convenience method that automatically generates a signal asset guid,
+     * adds the marker, and registers the callback so that {@link install} can wire up
+     * the `SignalReceiver` on the director's GameObject.
+     *
+     * @param time - Time in seconds when the signal fires
+     * @param callback - The function to invoke when the signal fires
+     * @param options - Optional marker configuration
+     *
+     * @example
+     * ```ts
+     * const timeline = TimelineBuilder.create("Sequence")
+     *     .signalTrack("Events")
+     *         .signal(1.0, () => console.log("1 second reached!"))
+     *         .signal(3.5, () => console.log("halfway!"), { emitOnce: true })
+     *     .install(director);
+     * ```
+     */
+    signal(time, callback, options) {
+        if (!this._currentTrack)
+            throw new Error("TimelineBuilder: .signal() must be called after a track method");
+        if (this._currentTrack.type !== TrackType.Signal && this._currentTrack.type !== TrackType.Marker) {
+            throw new Error(`TimelineBuilder: .signal() is only supported on signal and marker tracks, not "${this._currentTrack.type}"`);
+        }
+        const guid = this._idProvider.generateUUID();
+        const trackIndex = this._tracks.indexOf(this._currentTrack);
+        // Add the marker with the generated guid
+        const marker = {
+            type: MarkerType.Signal,
+            time,
+            retroActive: options?.retroActive ?? false,
+            emitOnce: options?.emitOnce ?? false,
+            asset: guid,
+        };
+        this._currentTrack.markers.push(marker);
+        // Store the pending signal for wiring during install()
+        this._pendingSignals.push({ trackIndex, guid, callback });
+        if (time > this._currentTrack.cursor) {
+            this._currentTrack.cursor = time;
+        }
+        return this;
+    }
+    /**
+     * Mutes the current track so it is skipped during playback.
+     */
+    muted(muted = true) {
+        if (!this._currentTrack)
+            throw new Error("TimelineBuilder: .muted() must be called after a track method");
+        this._currentTrack.muted = muted;
+        return this;
+    }
+    // #endregion
+    /**
+     * Builds and returns the {@link TimelineAssetModel}.
+     * Assign the result to `PlayableDirector.playableAsset` to play it.
+     *
+     * If you used `.signal()` with callbacks, use {@link install} instead — it calls `build()`
+     * internally and also wires up the SignalReceiver on the director's GameObject.
+     */
+    build() {
+        const tracks = this._tracks.map(t => {
+            const track = {
+                name: t.name,
+                type: t.type,
+                muted: t.muted,
+                outputs: t.outputs,
+            };
+            if (t.clips.length > 0)
+                track.clips = t.clips;
+            if (t.markers.length > 0)
+                track.markers = t.markers;
+            if (t.volume !== undefined)
+                track.volume = t.volume;
+            if (t.trackOffset !== undefined)
+                track.trackOffset = t.trackOffset;
+            return track;
+        });
+        return {
+            name: this._name,
+            tracks,
+        };
+    }
+    /**
+     * Builds the timeline asset, assigns it to the director, and wires up any
+     * `.signal()` callbacks by creating/configuring a {@link SignalReceiver} on the
+     * director's GameObject.
+     *
+     * @param director - The PlayableDirector to install the timeline on
+     * @returns The built TimelineAssetModel (also assigned to `director.playableAsset`)
+     *
+     * @example
+     * ```ts
+     * TimelineBuilder.create("MyTimeline")
+     *     .animationTrack("Anim", animator)
+     *         .clip(walkClip, { duration: 2 })
+     *     .signalTrack("Events")
+     *         .signal(1.0, () => console.log("signal fired!"))
+     *     .install(director);
+     *
+     * director.play();
+     * ```
+     */
+    install(director) {
+        const asset = this.build();
+        // Wire up signal callbacks
+        if (this._pendingSignals.length > 0) {
+            const obj = director.gameObject;
+            let receiver = GameObject.getComponent(obj, SignalReceiver);
+            if (!receiver) {
+                receiver = GameObject.addComponent(obj, SignalReceiver);
+            }
+            if (!receiver.events) {
+                receiver.events = [];
+            }
+            for (const pending of this._pendingSignals) {
+                const signalAsset = new SignalAsset();
+                signalAsset.guid = pending.guid;
+                const evt = new SignalReceiverEvent();
+                evt.signal = signalAsset;
+                evt.reaction = new EventList([pending.callback]);
+                receiver.events.push(evt);
+                // Wire the receiver as the output binding for the signal track
+                const track = asset.tracks[pending.trackIndex];
+                if (track && !track.outputs.includes(receiver)) {
+                    track.outputs.push(receiver);
+                }
+            }
+        }
+        director.playableAsset = asset;
+        return asset;
+    }
+    // #region Private helpers
+    pushTrack(name, type, binding) {
+        const track = {
+            name,
+            type,
+            muted: false,
+            outputs: binding ? [binding] : [],
+            clips: [],
+            markers: [],
+            cursor: 0,
+        };
+        this._tracks.push(track);
+        return track;
+    }
+}
+//# sourceMappingURL=TimelineBuilder.js.map

package/lib/engine-components/timeline/TimelineBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimelineBuilder.js","sourceRoot":"","sources":["../../../src/engine-components/timeline/TimelineBuilder.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AAEtF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEpF,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEnE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA2GjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,eAAe;IAChB,KAAK,CAAS;IACd,OAAO,GAAmB,EAAE,CAAC;IAC7B,aAAa,GAAwB,IAAI,CAAC;IAC1C,eAAe,GAAoB,EAAE,CAAC;IACtC,WAAW,CAAwB;IAE3C,YAAoB,IAAY,EAAE,IAAa;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAqB,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAa,EAAE,IAAa;QACtC,OAAO,IAAI,eAAe,CAAC,IAAI,IAAI,UAAU,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,yBAAyB;IAEzB;;;;OAIG;IACH,cAAc,CAAC,IAAY,EAAE,OAAoC;QAC7D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAY,EAAE,OAAuC,EAAE,MAAe;QAC7E,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAY,EAAE,OAAyB;QACnD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,IAAY;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAY,EAAE,OAA0C;QAChE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAY;QACpB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IAChB,CAAC;IAkBD,IAAI,CAAC,cAAyE,EAAE,OAAsE;QAClJ,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC;QAElI,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC;QAEjC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;gBACvB,MAAM,QAAQ,GAAG,cAA+B,CAAC;gBACjD,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAyB,CAAC;gBACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;gBACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzC,MAAM,GAAG,GAAG,KAAK,GAAG,QAAQ,CAAC;gBAE7B,MAAM,SAAS,GAAc;oBACzB,KAAK;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;oBAC1B,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;oBACxB,cAAc,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;oBAChC,eAAe,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC;oBAClC,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,IAAI,iBAAiB,CAAC,IAAI;oBACrE,qBAAqB,EAAE,IAAI,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,IAAI;oBACvE,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,KAAK;wBACxB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;wBAC3B,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,IAAI,KAAK;qBACxB;iBACjC,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5B,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM;YACV,CAAC;YAED,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;gBACnB,MAAM,GAAG,GAAG,cAAwB,CAAC;gBACrC,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAqB,CAAC;gBACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;gBAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzC,MAAM,GAAG,GAAG,KAAK,GAAG,QAAQ,CAAC;gBAE7B,MAAM,SAAS,GAAc;oBACzB,KAAK;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;oBAC1B,MAAM,EAAE,CAAC;oBACT,cAAc,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;oBAChC,eAAe,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC;oBAClC,oBAAoB,EAAE,iBAAiB,CAAC,IAAI;oBAC5C,qBAAqB,EAAE,iBAAiB,CAAC,IAAI;oBAC7C,KAAK,EAAE;wBACH,IAAI,EAAE,GAAG;wBACT,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,KAAK;wBACxB,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;qBACF;iBAC7B,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5B,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM;YACV,CAAC;YAED,KAAK,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxB,MAAM,IAAI,GAAG,cAAuC,CAAC;gBACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzC,MAAM,GAAG,GAAG,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC;gBAElC,MAAM,SAAS,GAAc;oBACzB,KAAK;oBACL,GAAG;oBACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,SAAS,EAAE,CAAC;oBACZ,MAAM,EAAE,CAAC;oBACT,cAAc,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;oBAChC,eAAe,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC;oBAClC,oBAAoB,EAAE,iBAAiB,CAAC,IAAI;oBAC5C,qBAAqB,EAAE,iBAAiB,CAAC,IAAI;oBAC7C,KAAK,EAAE,EAAE;iBACZ,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5B,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM;YACV,CAAC;YAED,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;gBACrB,MAAM,YAAY,GAAG,cAA0B,CAAC;gBAChD,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAuB,CAAC;gBACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;gBACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;gBAC/B,MAAM,GAAG,GAAG,KAAK,GAAG,QAAQ,CAAC;gBAE7B,MAAM,SAAS,GAAc;oBACzB,KAAK;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS,EAAE,CAAC;oBACZ,MAAM,EAAE,CAAC;oBACT,cAAc,EAAE,CAAC;oBACjB,eAAe,EAAE,CAAC;oBAClB,oBAAoB,EAAE,iBAAiB,CAAC,IAAI;oBAC5C,qBAAqB,EAAE,iBAAiB,CAAC,IAAI;oBAC7C,KAAK,EAAE;wBACH,YAAY;wBACZ,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,IAAI,IAAI;wBACjD,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI;qBACnB;iBAC/B,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5B,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM;YACV,CAAC;YAED;gBACI,MAAM,IAAI,KAAK,CAAC,4DAA4D,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QACnG,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAY,EAAE,KAAa,EAAE,OAA6B;QAC7D,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC3G,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,kFAAkF,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,CAAC;QAClI,CAAC;QAED,MAAM,MAAM,GAAsB;YAC9B,IAAI,EAAE,UAAU,CAAC,MAAM;YACvB,IAAI;YACJ,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,KAAK;YAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,KAAK;YACpC,KAAK;SACR,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAExC,gCAAgC;QAChC,IAAI,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAY,EAAE,QAAkB,EAAE,OAA6B;QAClE,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC3G,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,kFAAkF,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,CAAC;QAClI,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE5D,yCAAyC;QACzC,MAAM,MAAM,GAAsB;YAC9B,IAAI,EAAE,UAAU,CAAC,MAAM;YACvB,IAAI;YACJ,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,KAAK;YAC1C,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,KAAK;YACpC,KAAK,EAAE,IAAI;SACd,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAExC,uDAAuD;QACvD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1D,IAAI,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAiB,IAAI;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAC1G,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,aAAa;IAEb;;;;;;OAMG;IACH,KAAK;QACD,MAAM,MAAM,GAAiB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC9C,MAAM,KAAK,GAAe;gBACtB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,OAAO,EAAE,CAAC,CAAC,OAAO;aACrB,CAAC;YACF,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC9C,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;gBAAE,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;YACpD,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS;gBAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACpD,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS;gBAAE,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;YACnE,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM;SACT,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,QAA0B;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAE3B,2BAA2B;QAC3B,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,GAAG,GAAG,QAAQ,CAAC,UAAU,CAAC;YAChC,IAAI,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACnB,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC;YACzB,CAAC;YAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;gBACzC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;gBACtC,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;gBAEhC,MAAM,GAAG,GAAG,IAAI,mBAAmB,EAAE,CAAC;gBACtC,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;gBACzB,GAAG,CAAC,QAAQ,GAAG,IAAI,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACjD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAE1B,+DAA+D;gBAC/D,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBAC/C,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC7C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACjC,CAAC;YACL,CAAC;QACL,CAAC;QAED,QAAQ,CAAC,aAAa,GAAG,KAAK,CAAC;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,0BAA0B;IAElB,SAAS,CAAC,IAAY,EAAE,IAAe,EAAE,OAAsB;QACnE,MAAM,KAAK,GAAiB;YACxB,IAAI;YACJ,IAAI;YACJ,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YACjC,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,CAAC;SACZ,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACjB,CAAC;CAGJ"}

package/lib/engine-components/timeline/TimelineModels.d.ts

@@ -36,7 +36,7 @@ export declare enum ClipExtrapolation {
  * @category Animation and Sequencing
  * @see {@link PlayableDirector} for the main component to control timelines in Needle Engine.
  */
-export declare type TrackModel = {
+export type TrackModel = {
     name: string;
     type: TrackType;
     muted: boolean;
@@ -46,6 +46,7 @@ export declare type TrackModel = {
     trackOffset?: TrackOffset;
     volume?: number;
 };
+export declare function isTrackModel(obj: unknown): obj is TrackModel;
 declare type Vec3 = {
     x: number;
     y: number;

package/lib/engine-components/timeline/TimelineModels.js

@@ -26,6 +26,9 @@ export var ClipExtrapolation;
     ClipExtrapolation[ClipExtrapolation["Continue"] = 4] = "Continue";
 })(ClipExtrapolation || (ClipExtrapolation = {}));
 ;
+export function isTrackModel(obj) {
+    return typeof obj === "object" && obj !== null && "name" in obj && "type" in obj && "outputs" in obj && "muted" in obj;
+}
 export var MarkerType;
 (function (MarkerType) {
     MarkerType["Signal"] = "SignalEmitter";

package/lib/engine-components/timeline/TimelineModels.js.map

@@ -1 +1 @@
-{"version":3,"file":"TimelineModels.js","sourceRoot":"","sources":["../../../src/engine-components/timeline/TimelineModels.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAOX;AAPD,WAAY,SAAS;IACjB,2CAA8B,CAAA;IAC9B,yCAA4B,CAAA;IAC5B,iCAAoB,CAAA;IACpB,qCAAwB,CAAA;IACxB,mCAAsB,CAAA;IACtB,mCAAsB,CAAA;AAC1B,CAAC,EAPW,SAAS,KAAT,SAAS,QAOpB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IACzB,yDAAQ,CAAA;IACR,yDAAQ,CAAA;IACR,yDAAQ,CAAA;IACR,iEAAY,CAAA;IACZ,iEAAY,CAAA;AAChB,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAAA,CAAC;AAgFF,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IAClB,sCAAwB,CAAA;AAC5B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB"}
+{"version":3,"file":"TimelineModels.js","sourceRoot":"","sources":["../../../src/engine-components/timeline/TimelineModels.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAOX;AAPD,WAAY,SAAS;IACjB,2CAA8B,CAAA;IAC9B,yCAA4B,CAAA;IAC5B,iCAAoB,CAAA;IACpB,qCAAwB,CAAA;IACxB,mCAAsB,CAAA;IACtB,mCAAsB,CAAA;AAC1B,CAAC,EAPW,SAAS,KAAT,SAAS,QAOpB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IACzB,yDAAQ,CAAA;IACR,yDAAQ,CAAA;IACR,yDAAQ,CAAA;IACR,iEAAY,CAAA;IACZ,iEAAY,CAAA;AAChB,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAAA,CAAC;AAiBF,MAAM,UAAU,YAAY,CAAC,GAAW;IACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,IAAI,OAAO,IAAI,GAAG,CAAC;AAC3H,CAAC;AAiED,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IAClB,sCAAwB,CAAA;AAC5B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB"}

package/lib/engine-components/timeline/TimelineTracks.d.ts

@@ -69,6 +69,20 @@ export declare class AnimationTrackHandler extends TrackHandler {
 declare type AudioClipModel = Models.ClipModel & {
     _didTriggerPlay: boolean;
 };
+/**
+ * Handles audio playback for a timeline audio track.
+ *
+ * **Runtime mutation:** The track model is read fresh every frame during `evaluate()`.
+ * You can mutate `track.volume`, `clip.start`, `clip.end`, `clip.asset.volume` etc.
+ * at any time — changes take effect on the next frame without rebuilding the timeline.
+ *
+ * **Audio stopping:** Audio clips are automatically stopped when:
+ * - Timeline time moves outside a clip's `[start, end]` range (e.g. jumping or normal playback advancing past a clip)
+ * - The track is muted (via `muted = true`)
+ * - The director is stopped (`director.stop()`)
+ * - The director is paused (`director.pause()`)
+ * - The director is disabled or destroyed
+ */
 export declare class AudioTrackHandler extends TrackHandler {
     models: Array<AudioClipModel>;
     listener: AudioListener;
@@ -76,6 +90,9 @@ export declare class AudioTrackHandler extends TrackHandler {
     audioContextTimeOffset: Array<number>;
     lastTime: number;
     audioSource?: AudioSource;
+    /** Track-level volume multiplier (0–1). Applied on top of per-clip volume each frame. */
+    get volume(): number;
+    set volume(val: number);
     private _audioLoader;
     private getAudioFilePath;
     onAllowAudioChanged(allow: boolean): void;
@@ -106,6 +123,12 @@ export declare class SignalTrackHandler extends TrackHandler {
     models: Models.SignalMarkerModel[];
     didTrigger: boolean[];
     receivers: Array<SignalReceiver | null>;
+    private _lastTime;
+    onEnable(): void;
+    onMuteChanged(): void;
+    evaluate(time: number): void;
+}
+export declare class ActivationTrackHandler extends TrackHandler {
     evaluate(time: number): void;
 }
 export declare class ControlTrackHandler extends TrackHandler {

package/lib/engine-components/timeline/TimelineTracks.js

@@ -525,6 +525,20 @@ export class AnimationTrackHandler extends TrackHandler {
     }
 }
 const muteAudioTracks = getParam("mutetimeline");
+/**
+ * Handles audio playback for a timeline audio track.
+ *
+ * **Runtime mutation:** The track model is read fresh every frame during `evaluate()`.
+ * You can mutate `track.volume`, `clip.start`, `clip.end`, `clip.asset.volume` etc.
+ * at any time — changes take effect on the next frame without rebuilding the timeline.
+ *
+ * **Audio stopping:** Audio clips are automatically stopped when:
+ * - Timeline time moves outside a clip's `[start, end]` range (e.g. jumping or normal playback advancing past a clip)
+ * - The track is muted (via `muted = true`)
+ * - The director is stopped (`director.stop()`)
+ * - The director is paused (`director.pause()`)
+ * - The director is disabled or destroyed
+ */
 export class AudioTrackHandler extends TrackHandler {
     models = [];
     listener;
@@ -532,6 +546,9 @@ export class AudioTrackHandler extends TrackHandler {
     audioContextTimeOffset = [];
     lastTime = 0;
     audioSource;
+    /** Track-level volume multiplier (0–1). Applied on top of per-clip volume each frame. */
+    get volume() { return this.track.volume ?? 1; }
+    set volume(val) { this.track.volume = val; }
     _audioLoader = null;
     getAudioFilePath(path) {
         // TODO: this should be the timeline asset location probably which MIGHT be different
@@ -781,19 +798,27 @@ export class SignalTrackHandler extends TrackHandler {
     models = [];
     didTrigger = [];
     receivers = [];
-    // TODO: test when timeline signals are being reset in Unity
-    // onEnable() {
-    //     for (let i = 0; i < this.didTrigger?.length; i++) {
-    //         this.didTrigger[i] = false;
-    //     }
-    // }
-    // private _lastTime: number = -1;
+    _lastTime = -1;
+    onEnable() {
+        // Reset state so signals fire fresh on replay
+        this._lastTime = -1;
+        for (let i = 0; i < this.didTrigger.length; i++) {
+            this.didTrigger[i] = false;
+        }
+    }
+    onMuteChanged() {
+        // When unmuted, sync _lastTime to avoid stale comparisons
+        if (!this.track.muted) {
+            this._lastTime = -1;
+        }
+    }
     evaluate(time) {
         if (this.track.muted)
             return;
-        // let lastTime = this._lastTime;
-        // if (lastTime === -1) lastTime = time;
-        // this._lastTime = time;
+        let lastTime = this._lastTime;
+        if (lastTime === -1)
+            lastTime = time;
+        this._lastTime = time;
         const estimatedFrameLengthWithPadding = this.director.context.time.deltaTime * 1.5;
         for (let i = 0; i < this.models.length; i++) {
             const model = this.models[i];
@@ -813,7 +838,6 @@ export class SignalTrackHandler extends TrackHandler {
                     isActive = true;
                 }
             }
-            // console.log(time, td, isActive);
             if (isActive) {
                 if (!wasTriggered) {
                     if (debug)
@@ -832,9 +856,43 @@ export class SignalTrackHandler extends TrackHandler {
                     }
                 }
             }
-            else {
-                if (!model.emitOnce)
+            else if (!model.emitOnce) {
+                // Only reset didTrigger when time has moved backward past the signal
+                // (e.g. timeline looped or was scrubbed back). Don't reset just because
+                // the deltaTime-based activation window shrank on a fast frame.
+                if (time < model.time && lastTime >= model.time) {
                     this.didTrigger[i] = false;
+                }
+            }
+        }
+    }
+}
+export class ActivationTrackHandler extends TrackHandler {
+    evaluate(time) {
+        if (this.track.muted)
+            return;
+        // NE-3241 / NE-3737: Don't evaluate when stopped (preserves "Leave as is" post-playback).
+        // But DO evaluate if the user explicitly called director.evaluate().
+        if (!this.director.isPlaying && !this.director._isUserEvaluation)
+            return;
+        for (let i = 0; i < this.track.outputs.length; i++) {
+            const binding = this.track.outputs[i];
+            if (typeof binding !== "object" || binding === null)
+                continue;
+            let isActive = false;
+            if (this.track.clips) {
+                for (const clip of this.track.clips) {
+                    if (clip.start <= time && time <= clip.end) {
+                        isActive = true;
+                        break;
+                    }
+                }
+            }
+            const obj = binding;
+            if (obj.visible !== undefined && obj.visible !== isActive) {
+                obj.visible = isActive;
+                if (debug)
+                    console.warn(this.director.name, "ActivationTrack-" + i, obj.name, isActive, time);
             }
         }
     }