narraleaf-react 0.23.1 → 0.24.0

package/dist/game/nlcore/action/gameHistory.d.ts

@@ -9,7 +9,17 @@ type GameHistoryAction = {
 export type GameElementHistory = {
     type: "say";
     text: string;
+    /** Resolved clip URL of the line's voice, if any. */
     voice: string | null;
+    /**
+     * The line's `Sentence.config.voiceId` - the key its take is filed under, not a URL.
+     *
+     * A backlog UI that wants a replay button needs an id it can hand back to the host, because
+     * the host addresses audio by id (asset, voice unit) and a resolved URL is not one of those.
+     * Absent on entries recorded before this field existed, and on a line voiced through the
+     * inline `config.voice` rather than the scene's voice map.
+     */
+    voiceId?: string | number | null;
     character: string | null;
 } | {
     type: "menu";

package/dist/game/nlcore/gameTypes.d.ts

@@ -268,6 +268,9 @@ export type GameConfig = {
     /**
      * The delay in milliseconds before the game automatically shows the next sentence
      *
+     * Counted from the end of the line: the text has finished typing AND the line's voice, if any,
+     * has finished playing. A voiced line therefore waits out its clip and then this delay.
+     *
      * Only works when the player preference "autoForward" is enabled
      * @default 3000
      */

package/dist/game/player/elements/say/UIDialog.d.ts

@@ -42,6 +42,8 @@ export declare class DialogState {
     private _idle;
     private _active;
     private autoForwardScheduler;
+    /** Drops the listeners on a voice clip auto-forward is currently waiting out. */
+    private voiceWaitDisposer;
     constructor(config: DialogStateConfig);
     get state(): DialogStateType;
     get deps(): React.DependencyList;
@@ -78,7 +80,22 @@ export declare class DialogState {
     emitFlush(): this;
     onFlush(listener: () => void): EventToken;
     safeEmit(event: keyof DialogEvents, ...args: DialogEvents[keyof DialogEvents]): this;
+    /**
+     * Auto-forward waits for the line's voice before it starts counting.
+     *
+     * Typing finishing and the voice finishing are unrelated events - a fully-typed line whose actor
+     * is still mid-sentence is the normal case, not an edge one. Counting `autoForwardDelay` from the
+     * typing meant auto mode talked over the cast on every line longer than the delay, which is the
+     * one thing auto mode exists to avoid. The delay still applies afterwards, so the pause a player
+     * configured is a pause *after* the line rather than a race against it.
+     *
+     * A line with no voice, or one whose clip has already ended, schedules exactly as before.
+     */
     private scheduleAutoForward;
+    private scheduleAutoForwardDelay;
+    /** The token of this line's voice while it is still playing, or null - no voice, or already done. */
+    private getPlayingVoiceToken;
+    private releaseVoiceWait;
 }
 export default function PlayerDialog({ action, onFinished, useTypeEffect, gameState, active, }: Readonly<SayElementProps>): React.JSX.Element;
 export {};