@patterkit/runtime 0.21.0 → 0.23.0

package/dist/index.d.cts

@@ -2,7 +2,13 @@ import { ScalarValue } from '@wildwinter/expr';
 import { ScopeRegistry, PropertyBag, ScopeDeclaration, LogMount, ScopeResolver, PropertyRow } from '@wildwinter/scoperegistry';
 export { PropertyRow } from '@wildwinter/scoperegistry';
 import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
-export { Bundle, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+
+/** A beat's own `padAfter` (when it sets one) and its resolved one (always). */
+interface BeatPad {
+    own?: number;
+    resolved: number;
+}
 
 type SelectableNode = CompiledGroup | CompiledSnippet;
 
@@ -14,12 +20,16 @@ type StepResult = {
     character?: string;
     characterName?: string;
     direction?: string;
+    qualifier?: string;
+    qualifierName?: string;
+    padAfter: number;
     gameData?: GameData;
     tags?: string[];
 } | {
     type: "text";
     id: string;
     text: string;
+    padAfter: number;
     gameData?: GameData;
     tags?: string[];
 } | {
@@ -44,6 +54,15 @@ interface BeatInfo {
     characterName?: string;
     /** Performance direction (line only). */
     direction?: string;
+    /** Speaker qualifier `gameId` (line only), e.g. `vo`. */
+    qualifier?: string;
+    /** The qualifier's shown name (source locale), e.g. `V.O.`. */
+    qualifierName?: string;
+    /** The pause after this beat, in seconds, resolved from its own value and the defaults above it (line and
+     *  text only; see line padding). What a delivered step carries. */
+    padAfter?: number;
+    /** The beat's own `padAfter`, when it sets one (line and text only). */
+    ownPadAfter?: number;
     /** Source text, un-interpolated (line / text). Omitted for gameEvent and IDs-only bundles. */
     text?: string;
     /** Author gameData overrides on this beat (raw, as the step carries them). Omitted when empty. */
@@ -111,6 +130,12 @@ interface ChoicePrompt {
     /** The speaker's resolved player-facing name (locale-aware; absent when the character has none). */
     characterName?: string;
     direction?: string;
+    /** The speaker qualifier's `gameId` (`vo`), and its resolved shown name (locale-aware). */
+    qualifier?: string;
+    qualifierName?: string;
+    /** The prompt's resolved pause, in seconds: when it is spoken (by `replayPromptOnChoose`, or by a game that
+     *  voices it), the wait before the reply, negative to cut in on the question (line padding). */
+    padAfter: number;
 }
 /** A single option of a pending `choice` group. */
 interface ChoiceOption {
@@ -352,6 +377,8 @@ interface FlowHost {
     defaultStrings: Record<string, string>;
     /** Cast canonical name -> authoring `displayName` (the unlocalised fallback when no loc string exists). */
     castDisplay: Map<string, string>;
+    /** Speaker qualifier gameId -> authored name (the unlocalised fallback when no loc string exists). */
+    qualifierDisplay: Map<string, string>;
     nodeIndex: Map<string, SelectableNode>;
     blockIndex: Map<string, {
         sceneId: string;
@@ -363,6 +390,8 @@ interface FlowHost {
     blockGameIdToId: Map<string, Map<string, string>>;
     /** Author tags (#215): node id -> accumulated tags (own + every ancestor's, deduped). Built once. */
     tagIndex: Map<string, string[]>;
+    /** Every line and text beat's resolved pause (line padding), precomputed per bundle (pads.ts). */
+    padIndex: Map<string, BeatPad>;
     /** The game's one registry: `@patter` (the SHARED globals), host scopes, every instance bag. */
     registry: ScopeRegistry;
     /** True when the engine made the registry (a standalone game): `saveGame()` then carries its values. */
@@ -994,6 +1023,16 @@ declare class Flow {
      *  locale, else the authoring `displayName`. Undefined when the character has no display name at all
      *  (the host falls back to the `character` token itself). */
     private resolveCharacterName;
+    /** The resolved pause of the beat an option shows as its prompt (its authored prompt, else its first content
+     *  line), for a saved option that predates prompts carrying one. */
+    private promptPadOf;
+    /** A line or text beat's resolved pause (line padding): its own `padAfter`, else the nearest default above
+     *  it, else the project's, else the built-in one; clamped to zero on a snippet's last line. */
+    private padOf;
+    /** A speaker qualifier's shown name, resolved as a character's is: the `qualifier:<gameId>` string in the
+     *  active locale, else the default locale, else the authored name. Undefined in IDs-only mode (the game
+     *  maps the `qualifier` gameId itself). */
+    private resolveQualifierName;
     /** Split a ref into scope + name. Tokens: `@scene`, registered tokens, else `@patter` (incl. bare `@name`). */
     private splitRef;
     /** A fresh, unregistered bag for the NOT-shared `@patter` globals (the shared ones live on the host). */

package/dist/index.d.ts

@@ -2,7 +2,13 @@ import { ScalarValue } from '@wildwinter/expr';
 import { ScopeRegistry, PropertyBag, ScopeDeclaration, LogMount, ScopeResolver, PropertyRow } from '@wildwinter/scoperegistry';
 export { PropertyRow } from '@wildwinter/scoperegistry';
 import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
-export { Bundle, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+
+/** A beat's own `padAfter` (when it sets one) and its resolved one (always). */
+interface BeatPad {
+    own?: number;
+    resolved: number;
+}
 
 type SelectableNode = CompiledGroup | CompiledSnippet;
 
@@ -14,12 +20,16 @@ type StepResult = {
     character?: string;
     characterName?: string;
     direction?: string;
+    qualifier?: string;
+    qualifierName?: string;
+    padAfter: number;
     gameData?: GameData;
     tags?: string[];
 } | {
     type: "text";
     id: string;
     text: string;
+    padAfter: number;
     gameData?: GameData;
     tags?: string[];
 } | {
@@ -44,6 +54,15 @@ interface BeatInfo {
     characterName?: string;
     /** Performance direction (line only). */
     direction?: string;
+    /** Speaker qualifier `gameId` (line only), e.g. `vo`. */
+    qualifier?: string;
+    /** The qualifier's shown name (source locale), e.g. `V.O.`. */
+    qualifierName?: string;
+    /** The pause after this beat, in seconds, resolved from its own value and the defaults above it (line and
+     *  text only; see line padding). What a delivered step carries. */
+    padAfter?: number;
+    /** The beat's own `padAfter`, when it sets one (line and text only). */
+    ownPadAfter?: number;
     /** Source text, un-interpolated (line / text). Omitted for gameEvent and IDs-only bundles. */
     text?: string;
     /** Author gameData overrides on this beat (raw, as the step carries them). Omitted when empty. */
@@ -111,6 +130,12 @@ interface ChoicePrompt {
     /** The speaker's resolved player-facing name (locale-aware; absent when the character has none). */
     characterName?: string;
     direction?: string;
+    /** The speaker qualifier's `gameId` (`vo`), and its resolved shown name (locale-aware). */
+    qualifier?: string;
+    qualifierName?: string;
+    /** The prompt's resolved pause, in seconds: when it is spoken (by `replayPromptOnChoose`, or by a game that
+     *  voices it), the wait before the reply, negative to cut in on the question (line padding). */
+    padAfter: number;
 }
 /** A single option of a pending `choice` group. */
 interface ChoiceOption {
@@ -352,6 +377,8 @@ interface FlowHost {
     defaultStrings: Record<string, string>;
     /** Cast canonical name -> authoring `displayName` (the unlocalised fallback when no loc string exists). */
     castDisplay: Map<string, string>;
+    /** Speaker qualifier gameId -> authored name (the unlocalised fallback when no loc string exists). */
+    qualifierDisplay: Map<string, string>;
     nodeIndex: Map<string, SelectableNode>;
     blockIndex: Map<string, {
         sceneId: string;
@@ -363,6 +390,8 @@ interface FlowHost {
     blockGameIdToId: Map<string, Map<string, string>>;
     /** Author tags (#215): node id -> accumulated tags (own + every ancestor's, deduped). Built once. */
     tagIndex: Map<string, string[]>;
+    /** Every line and text beat's resolved pause (line padding), precomputed per bundle (pads.ts). */
+    padIndex: Map<string, BeatPad>;
     /** The game's one registry: `@patter` (the SHARED globals), host scopes, every instance bag. */
     registry: ScopeRegistry;
     /** True when the engine made the registry (a standalone game): `saveGame()` then carries its values. */
@@ -994,6 +1023,16 @@ declare class Flow {
      *  locale, else the authoring `displayName`. Undefined when the character has no display name at all
      *  (the host falls back to the `character` token itself). */
     private resolveCharacterName;
+    /** The resolved pause of the beat an option shows as its prompt (its authored prompt, else its first content
+     *  line), for a saved option that predates prompts carrying one. */
+    private promptPadOf;
+    /** A line or text beat's resolved pause (line padding): its own `padAfter`, else the nearest default above
+     *  it, else the project's, else the built-in one; clamped to zero on a snippet's last line. */
+    private padOf;
+    /** A speaker qualifier's shown name, resolved as a character's is: the `qualifier:<gameId>` string in the
+     *  active locale, else the default locale, else the authored name. Undefined in IDs-only mode (the game
+     *  maps the `qualifier` gameId itself). */
+    private resolveQualifierName;
     /** Split a ref into scope + name. Tokens: `@scene`, registered tokens, else `@patter` (incl. bare `@name`). */
     private splitRef;
     /** A fresh, unregistered bag for the NOT-shared `@patter` globals (the shared ones live on the host). */

package/dist/index.js

@@ -4,7 +4,7 @@ import { matchedSpecificity as scoreSpecificity } from "@wildwinter/expr-specifi
 import { ScopeRegistry } from "@wildwinter/scoperegistry";
 import { defaultFor, PropertyBag } from "@wildwinter/scoperegistry";
 import { patterDialect, interpolate, splitRef, stripCaptions } from "@patterkit/dialect";
-import { walkNodes, effectiveGameId, castStringKey, DEFAULT_CAPTION_DELIMITERS, DEFAULT_CAPTION_CHARACTER } from "@patterkit/model";
+import { walkNodes, effectiveGameId, castStringKey, qualifierStringKey, DEFAULT_PAD_AFTER as DEFAULT_PAD_AFTER2, DEFAULT_CAPTION_DELIMITERS, DEFAULT_CAPTION_CHARACTER } from "@patterkit/model";
 
 // src/tags.ts
 function dedupe(tags) {
@@ -40,6 +40,45 @@ function buildTagIndex(bundle) {
   return index;
 }
 
+// src/pads.ts
+import { DEFAULT_PAD_AFTER } from "@patterkit/model";
+var spoken = (b) => b.kind === "line" || b.kind === "text";
+var num = (v) => typeof v === "number" && Number.isFinite(v) ? v : void 0;
+function buildPadIndex(bundle) {
+  const index = /* @__PURE__ */ new Map();
+  const set = (beat, inherited, clamp) => {
+    const own = beat.kind === "gameEvent" ? void 0 : num(beat.padAfter);
+    let resolved = own ?? inherited;
+    if (clamp && resolved < 0) resolved = 0;
+    index.set(beat.id, own !== void 0 ? { own, resolved } : { resolved });
+  };
+  const visit = (node, inherited) => {
+    const def = num(node.padAfterDefault) ?? inherited;
+    if (node.type === "group") {
+      if (node.prompt) set(node.prompt, def, false);
+      for (const child of node.children) visit(child, def);
+      return;
+    }
+    const beats = node.beats ?? [];
+    let last = -1;
+    beats.forEach((b, i) => {
+      if (spoken(b)) last = i;
+    });
+    beats.forEach((b, i) => {
+      if (spoken(b)) set(b, def, i === last);
+    });
+  };
+  const projectDefault = num(bundle.padAfterDefault) ?? DEFAULT_PAD_AFTER;
+  for (const scene of Object.values(bundle.scenes)) {
+    const sceneDefault = num(scene.padAfterDefault) ?? projectDefault;
+    for (const block of scene.blocks) {
+      const blockDefault = num(block.padAfterDefault) ?? sceneDefault;
+      for (const child of block.children) visit(child, blockDefault);
+    }
+  }
+  return index;
+}
+
 // src/engine.ts
 import { SAVE_VERSION } from "@patterkit/model";
 var astCache = /* @__PURE__ */ new WeakMap();
@@ -52,6 +91,15 @@ function tagIndexFor(bundle) {
   }
   return index;
 }
+var padIndexCache = /* @__PURE__ */ new WeakMap();
+function padIndexFor(bundle) {
+  let index = padIndexCache.get(bundle);
+  if (!index) {
+    index = buildPadIndex(bundle);
+    padIndexCache.set(bundle, index);
+  }
+  return index;
+}
 function tagsOf(host, id) {
   return host.tagIndex.get(id)?.slice();
 }
@@ -117,6 +165,8 @@ var Engine = class _Engine {
     }
     const castDisplay = /* @__PURE__ */ new Map();
     for (const c of bundle.cast ?? []) if (c.displayName) castDisplay.set(c.name, c.displayName);
+    const qualifierDisplay = /* @__PURE__ */ new Map();
+    for (const q of bundle.qualifiers ?? []) if (q?.gameId) qualifierDisplay.set(q.gameId, q.name);
     this.defaultSeed = (options.seed ?? 2654435769) >>> 0;
     const nodeIndex = /* @__PURE__ */ new Map();
     const blockIndex = /* @__PURE__ */ new Map();
@@ -177,6 +227,7 @@ var Engine = class _Engine {
       strings,
       defaultStrings,
       castDisplay,
+      qualifierDisplay,
       nodeIndex,
       blockIndex,
       blockById,
@@ -184,6 +235,7 @@ var Engine = class _Engine {
       blockGameIdToId: this.blockGameIdToId,
       // same instances the engine resolves with
       tagIndex: tagIndexFor(bundle),
+      padIndex: padIndexFor(bundle),
       registry,
       ownsRegistry,
       patterBag,
@@ -581,8 +633,16 @@ var Engine = class _Engine {
         if (name !== void 0) info.characterName = name;
       }
       if (beat.direction !== void 0) info.direction = beat.direction;
+      if (beat.qualifier !== void 0) {
+        info.qualifier = beat.qualifier;
+        const name = this.host.defaultStrings[qualifierStringKey(beat.qualifier)] ?? this.host.qualifierDisplay.get(beat.qualifier);
+        if (name !== void 0) info.qualifierName = name;
+      }
     }
     if (beat.kind === "line" || beat.kind === "text") {
+      const pad = this.host.padIndex.get(beat.id);
+      info.padAfter = pad?.resolved ?? DEFAULT_PAD_AFTER2;
+      if (pad?.own !== void 0) info.ownPadAfter = pad.own;
       const source = this.host.defaultStrings[beat.id];
       if (source !== void 0) info.text = source;
     }
@@ -1376,7 +1436,8 @@ var Flow = class {
         const node = this.host.nodeIndex.get(o.id);
         if (!node) continue;
         byId.set(o.id, node);
-        options.push({ ...o });
+        const { prompt: saved, ...rest } = o;
+        options.push({ ...rest, ...saved ? { prompt: { ...saved, padAfter: saved.padAfter ?? this.promptPadOf(node) } } : {} });
       }
       if (options.length > 0) this.pendingChoice = { groupId: c.pendingChoice.groupId, options, byId };
     }
@@ -1385,7 +1446,7 @@ var Flow = class {
     if (this.pendingPromptOwnerId) {
       const owner = this.host.nodeIndex.get(this.pendingPromptOwnerId);
       const beat = owner ? this.authoredPromptOf(owner) : void 0;
-      if (beat) this.pendingPrompt = { beat, ...c.pendingPrompt ? { shown: { ...c.pendingPrompt } } : {} };
+      if (beat) this.pendingPrompt = { beat, ...c.pendingPrompt ? { shown: { ...c.pendingPrompt, padAfter: c.pendingPrompt.padAfter ?? this.padOf(beat.id) } } : {} };
       else this.pendingPromptOwnerId = null;
     }
   }
@@ -1755,7 +1816,7 @@ var Flow = class {
       case "gameEvent":
         return { type: "gameEvent", id: beat.id, gameData: beat.gameData, ...withTags };
       case "text":
-        return { type: "text", id: beat.id, text: this.interpolate(this.resolveString(beat.id)), gameData: beat.gameData, ...withTags };
+        return { type: "text", id: beat.id, text: this.interpolate(this.resolveString(beat.id)), padAfter: this.padOf(beat.id), gameData: beat.gameData, ...withTags };
       case "line": {
         const raw = this.resolveString(beat.id);
         const off = !this.host.captionsOn;
@@ -1769,6 +1830,10 @@ var Flow = class {
           character: silent ? void 0 : beat.character,
           characterName: silent ? void 0 : this.resolveCharacterName(beat.character),
           direction: silent ? void 0 : beat.direction,
+          qualifier: silent ? void 0 : beat.qualifier,
+          qualifierName: silent ? void 0 : this.resolveQualifierName(beat.qualifier),
+          padAfter: this.padOf(beat.id),
+          // a silent line still fires, so it still carries its pause
           gameData: beat.gameData,
           ...withTags
         };
@@ -1807,7 +1872,17 @@ var Flow = class {
     const beat = this.promptBeatOf(node);
     if (!beat) return void 0;
     const text = this.interpolate(this.resolveString(beat.id));
-    return beat.kind === "line" ? { kind: "line", text: this.captionLine(text), character: beat.character, characterName: this.resolveCharacterName(beat.character), direction: beat.direction } : { kind: "text", text };
+    const padAfter = this.padOf(beat.id);
+    return beat.kind === "line" ? {
+      kind: "line",
+      text: this.captionLine(text),
+      character: beat.character,
+      characterName: this.resolveCharacterName(beat.character),
+      direction: beat.direction,
+      qualifier: beat.qualifier,
+      qualifierName: this.resolveQualifierName(beat.qualifier),
+      padAfter
+    } : { kind: "text", text, padAfter };
   }
   /** An option's AUTHORED prompt beat: an Option group's own `prompt`. The only prompt a replay speaks. */
   authoredPromptOf(node) {
@@ -1818,7 +1893,7 @@ var Flow = class {
   promptResult(beat, shown) {
     const tags = tagsOf(this.host, beat.id);
     const withTags = tags && tags.length ? { tags } : {};
-    if (shown.kind === "text") return { type: "text", id: beat.id, text: shown.text, gameData: beat.gameData, ...withTags };
+    if (shown.kind === "text") return { type: "text", id: beat.id, text: shown.text, padAfter: this.padOf(beat.id), gameData: beat.gameData, ...withTags };
     return {
       type: "line",
       id: beat.id,
@@ -1826,6 +1901,9 @@ var Flow = class {
       character: shown.character,
       characterName: shown.characterName,
       direction: shown.direction,
+      qualifier: shown.qualifier,
+      qualifierName: shown.qualifierName,
+      padAfter: this.padOf(beat.id),
       gameData: beat.gameData,
       ...withTags
     };
@@ -1862,6 +1940,26 @@ var Flow = class {
     const key = castStringKey(character);
     return this.host.strings[key] ?? this.host.defaultStrings[key] ?? this.host.castDisplay.get(character);
   }
+  /** The resolved pause of the beat an option shows as its prompt (its authored prompt, else its first content
+   *  line), for a saved option that predates prompts carrying one. */
+  promptPadOf(node) {
+    const beat = this.promptBeatOf(node);
+    return beat ? this.padOf(beat.id) : DEFAULT_PAD_AFTER2;
+  }
+  /** A line or text beat's resolved pause (line padding): its own `padAfter`, else the nearest default above
+   *  it, else the project's, else the built-in one; clamped to zero on a snippet's last line. */
+  padOf(beatId) {
+    return this.host.padIndex.get(beatId)?.resolved ?? DEFAULT_PAD_AFTER2;
+  }
+  /** A speaker qualifier's shown name, resolved as a character's is: the `qualifier:<gameId>` string in the
+   *  active locale, else the default locale, else the authored name. Undefined in IDs-only mode (the game
+   *  maps the `qualifier` gameId itself). */
+  resolveQualifierName(qualifier) {
+    if (qualifier === void 0) return void 0;
+    if (this.host.emitIds) return void 0;
+    const key = qualifierStringKey(qualifier);
+    return this.host.strings[key] ?? this.host.defaultStrings[key] ?? this.host.qualifierDisplay.get(qualifier);
+  }
   /** Split a ref into scope + name. Tokens: `@scene`, registered tokens, else `@patter` (incl. bare `@name`). */
   splitRef(ref) {
     return splitHostRef(this.host, ref);
@@ -1958,6 +2056,9 @@ function savedPrompt(p) {
   if (p.character !== void 0) out.character = p.character;
   if (p.characterName !== void 0) out.characterName = p.characterName;
   if (p.direction !== void 0) out.direction = p.direction;
+  if (p.qualifier !== void 0) out.qualifier = p.qualifier;
+  if (p.qualifierName !== void 0) out.qualifierName = p.qualifierName;
+  if (typeof p.padAfter === "number") out.padAfter = p.padAfter;
   return out;
 }
 function serialiseSelectors(map) {
@@ -2048,6 +2149,9 @@ function truthy(v) {
   return v.length > 0;
 }
 
+// src/index.ts
+import { DEFAULT_PAD_AFTER as DEFAULT_PAD_AFTER3 } from "@patterkit/model";
+
 // src/describe.ts
 import { effectiveGameId as effectiveGameId2 } from "@patterkit/model";
 var isShared = (d, scopeDefault) => d.shared ?? scopeDefault;
@@ -2170,6 +2274,7 @@ function effectiveGameData(fields, node) {
 }
 export {
   Checkpoint,
+  DEFAULT_PAD_AFTER3 as DEFAULT_PAD_AFTER,
   Engine,
   Flow,
   buildTagIndex,