@patterkit/runtime 0.4.5 → 0.5.0

package/dist/index.d.cts

@@ -439,6 +439,23 @@ declare class Engine {
     tagsForScene(sceneRef: string): string[];
     /** A block's accumulated tags (scene + block), by scene + block ref (id or gameId). Empty when none / unknown. */
     tagsForBlock(sceneRef: string, blockRef: string): string[];
+    /**
+     * Every cast member the PROJECT declares, in authored order - the same list `describeBundle` counts.
+     * A superset of any scene's cast: the validator holds a beat's `character` to a declared member, so
+     * {@link castForScene} and {@link castForBlock} only ever return names that appear here.
+     */
+    getCast(): string[];
+    /**
+     * A scene's cast: the `character` token of every speaker with a line anywhere in it, deduped, in
+     * first-appearance order. Static, like {@link getOutline}: it walks the authored structure, so a
+     * speaker behind a condition, inside any group, or voicing a choice prompt counts - this is who CAN
+     * speak in the scene, not who a given playthrough heard. Empty for an unknown ref, or a scene with no
+     * dialogue. Tokens, not display names: resolve those through the delivered step (`characterName`),
+     * which is what follows `setLocale`.
+     */
+    castForScene(sceneRef: string): string[];
+    /** One block's cast, by scene + block ref (id or gameId). {@link castForScene} scoped to a block. */
+    castForBlock(sceneRef: string, blockRef: string): string[];
     /**
      * The authored structure as a nested tree: scenes -> blocks -> children (groups + snippets, groups
      * preserved) -> a snippet's beats. Static (no flow / play state); per-beat data is read at the source

package/dist/index.d.ts

@@ -439,6 +439,23 @@ declare class Engine {
     tagsForScene(sceneRef: string): string[];
     /** A block's accumulated tags (scene + block), by scene + block ref (id or gameId). Empty when none / unknown. */
     tagsForBlock(sceneRef: string, blockRef: string): string[];
+    /**
+     * Every cast member the PROJECT declares, in authored order - the same list `describeBundle` counts.
+     * A superset of any scene's cast: the validator holds a beat's `character` to a declared member, so
+     * {@link castForScene} and {@link castForBlock} only ever return names that appear here.
+     */
+    getCast(): string[];
+    /**
+     * A scene's cast: the `character` token of every speaker with a line anywhere in it, deduped, in
+     * first-appearance order. Static, like {@link getOutline}: it walks the authored structure, so a
+     * speaker behind a condition, inside any group, or voicing a choice prompt counts - this is who CAN
+     * speak in the scene, not who a given playthrough heard. Empty for an unknown ref, or a scene with no
+     * dialogue. Tokens, not display names: resolve those through the delivered step (`characterName`),
+     * which is what follows `setLocale`.
+     */
+    castForScene(sceneRef: string): string[];
+    /** One block's cast, by scene + block ref (id or gameId). {@link castForScene} scoped to a block. */
+    castForBlock(sceneRef: string, blockRef: string): string[];
     /**
      * The authored structure as a nested tree: scenes -> blocks -> children (groups + snippets, groups
      * preserved) -> a snippet's beats. Static (no flow / play state); per-beat data is read at the source

package/dist/index.js

@@ -328,6 +328,42 @@ var Engine = class _Engine {
     const id = this.resolveBlockRef(sceneId, blockRef);
     return (id != null ? this.host.tagIndex.get(id) : void 0) ?? [];
   }
+  /**
+   * Every cast member the PROJECT declares, in authored order - the same list `describeBundle` counts.
+   * A superset of any scene's cast: the validator holds a beat's `character` to a declared member, so
+   * {@link castForScene} and {@link castForBlock} only ever return names that appear here.
+   */
+  getCast() {
+    const names = [];
+    for (const c of this.host.bundle.cast ?? []) if (c?.name) names.push(c.name);
+    return names;
+  }
+  /**
+   * A scene's cast: the `character` token of every speaker with a line anywhere in it, deduped, in
+   * first-appearance order. Static, like {@link getOutline}: it walks the authored structure, so a
+   * speaker behind a condition, inside any group, or voicing a choice prompt counts - this is who CAN
+   * speak in the scene, not who a given playthrough heard. Empty for an unknown ref, or a scene with no
+   * dialogue. Tokens, not display names: resolve those through the delivered step (`characterName`),
+   * which is what follows `setLocale`.
+   */
+  castForScene(sceneRef) {
+    const id = this.resolveSceneRef(sceneRef);
+    const scene = id != null ? this.host.bundle.scenes[id] : void 0;
+    if (!scene) return [];
+    const out = /* @__PURE__ */ new Set();
+    for (const block of scene.blocks) collectCast(block.children, out);
+    return [...out];
+  }
+  /** One block's cast, by scene + block ref (id or gameId). {@link castForScene} scoped to a block. */
+  castForBlock(sceneRef, blockRef) {
+    const sceneId = this.resolveSceneRef(sceneRef);
+    const id = this.resolveBlockRef(sceneId, blockRef);
+    const block = id != null ? this.host.blockById.get(id) : void 0;
+    if (!block) return [];
+    const out = /* @__PURE__ */ new Set();
+    collectCast(block.children, out);
+    return [...out];
+  }
   /**
    * The authored structure as a nested tree: scenes -> blocks -> children (groups + snippets, groups
    * preserved) -> a snippet's beats. Static (no flow / play state); per-beat data is read at the source
@@ -1321,6 +1357,15 @@ var Flow = class {
     }
   }
 };
+function collectCast(nodes, out) {
+  walkNodes(nodes, (n) => {
+    if (n.type === "group") {
+      if (n.prompt?.kind === "line" && n.prompt.character) out.add(n.prompt.character);
+      return;
+    }
+    for (const beat of n.beats ?? []) if (beat.kind === "line" && beat.character) out.add(beat.character);
+  });
+}
 function serialiseSelectors(map) {
   const out = {};
   for (const [id, st] of map) {