import type { ScenarioModel } from '../model/scenario-model.js';
/**
* Turns Valkyrie dialog text into something a TTS voice can read aloud: {qst:} entries are
* expanded, icons become words, markup is dropped, and text that only exists while playing
* ({rnd:hero}, {var:}) is replaced or left out with a note.
*/
/**
* Which part of the text to speak. Community scenarios set the story in italics
* ("You come across an old tome.\n\nTest {lore}."), so "auto" speaks only the
* italic parts when there are any, and the whole text otherwise.
*/
export type NarrationPart = 'auto' | 'flavor' | 'all';
export interface SpeechTextOptions {
part?: NarrationPart;
/** Resolves {qst:KEY}; usually model.localization.get */
lookup?: (key: string) => string | undefined;
/** Word -> respelling for names the voice gets wrong, e.g. { Cthulhu: "Kuh-thoo-loo" } */
pronunciations?: Record;
}
export interface SpeechText {
/** Paragraphs joined by blank lines; empty when nothing is left to say */
text: string;
paragraphs: string[];
/** What was replaced or dropped because it is only known during play */
notes: string[];
}
/** {ffg:TILE_TOWN_SQUARE_MAD20} -> "town square" */
export declare function humanizeFfgKey(key: string): string;
export declare function speechText(raw: string, opts?: SpeechTextOptions): SpeechText;
/** The localized text a component shows (.text), or undefined when it has none */
export declare function componentText(model: ScenarioModel, name: string): string | undefined;
//# sourceMappingURL=narration-text.d.ts.map