narrat 0.11.6 → 1.0.0

package/lib/stores/audio-store.d.ts

@@ -0,0 +1,11 @@
+export interface AudioState {
+    currentMusic?: string;
+    musicHowlId?: number;
+}
+export declare type AudioSave = Omit<AudioState, 'musicHowlId'>;
+export declare const useAudio: import("pinia").StoreDefinition<"audio", AudioState, {}, {
+    stopMusic(): void;
+    setMusic(music: string, soundId: number): void;
+    generateSaveData(): AudioSave;
+    loadSaveData(data: AudioSave): void;
+}>;

package/lib/stores/dialog-store.d.ts

@@ -0,0 +1,27 @@
+export declare type AddDialogParams = Omit<DialogKey, 'id' | 'interactive'> & {
+    interactive?: boolean;
+};
+export interface DialogKey {
+    speaker: string;
+    text: string;
+    pose?: string;
+    choices?: DialogChoice[];
+    interactive: boolean;
+    id: string;
+}
+export interface DialogChoice {
+    choice: string;
+    originalIndex: number;
+    allowed: boolean;
+}
+declare type DialogState = {
+    dialog: DialogKey[];
+};
+export declare type DialogSave = DialogState;
+export declare const useDialogStore: import("pinia").StoreDefinition<"dialog", DialogState, {}, {
+    generateSaveData(): DialogSave;
+    loadSaveData(data: DialogSave): void;
+    addDialog(dialog: AddDialogParams): void;
+    clearDialog(): void;
+}>;
+export {};

package/lib/stores/hud-stats-store.d.ts

@@ -0,0 +1,20 @@
+import { HudStatConfig } from '../config';
+export interface HudStatsState {
+    [key: string]: HudStat;
+}
+export interface HudStat {
+    value: number;
+}
+export interface HudState {
+    hudStats: HudStatsState;
+}
+export declare type HudSave = HudState;
+export declare const useHud: import("pinia").StoreDefinition<"hud", HudState, {}, {
+    setupHudStats(stats: {
+        [key: string]: HudStatConfig;
+    }): void;
+    setStat(stat: string, value: number): void;
+    addStat(stat: string, value: number): void;
+    generateSaveData(): HudSave;
+    loadSaveData(data: HudSave): void;
+}>;

package/lib/stores/main-store.d.ts

@@ -0,0 +1,256 @@
+import { GameSave } from '@/types/game-save';
+import { AppOptions, Config } from '..';
+export interface ErrorState {
+    text: string;
+}
+interface MainState {
+    ready: boolean;
+    playing: boolean;
+    errors: ErrorState[];
+    playTime: {
+        start: number;
+        previousPlaytime: number;
+    };
+    options: AppOptions;
+    flowState: 'menu' | 'playing';
+    modal: string | false;
+    paused: boolean;
+}
+export interface MainSaveData {
+    playTime: number;
+}
+export declare const useMain: import("pinia").StoreDefinition<"main", MainState, {}, {
+    setup(scriptPaths: string[], config: Config): Promise<void>;
+    startMachine(): void;
+    startGame(): Promise<void>;
+    loadGame(saveFile: string): Promise<void>;
+    playerAnswered(index: number): void;
+    menuReturn(): void;
+    createError(text: string): void;
+    clearErrors(): void;
+    setFlowState(flowState: 'menu' | 'playing'): void;
+    openModal(modal: string): void;
+    closeModal(): void;
+    toggleMenu(): void;
+    pause(): void;
+    unpause(): void;
+    setOptions(options: AppOptions): void;
+    startPlaying(): void;
+    reset(): void;
+    generateSaveData(): MainSaveData;
+    loadSaveData(data: MainSaveData): void;
+    saveGame(): void;
+    setLoadedData(save: GameSave): void;
+    getAllStates(): {
+        main: any & {
+            ready: boolean;
+            playing: boolean;
+            errors: {
+                text: string;
+            }[];
+            playTime: {
+                start: number;
+                previousPlaytime: number;
+            };
+            options: {
+                logging: boolean;
+                debug: boolean;
+            };
+            flowState: 'menu' | 'playing';
+            modal: string | false;
+            paused: boolean;
+        } & import("pinia")._StoreWithState<"main", MainState, {}, any> & import("pinia")._StoreWithGetters<{}> & import("pinia").PiniaCustomProperties<string, import("pinia").StateTree, import("pinia")._GettersTree<import("pinia").StateTree>, import("pinia")._ActionsTree>;
+        screens: import("pinia").Store<"screens", {
+            currentScreen: string;
+            buttons: import("./screens-store").ButtonsState;
+        }, {}, {
+            setScreen(screen: string): void;
+            setButtons(buttons: {
+                [key: string]: import("..").ButtonConfig;
+            }): void;
+            changeButton(button: string, newValue: boolean): void;
+            generateSaveData(): import("./screens-store").ScreenState;
+            loadSaveData(data: import("./screens-store").ScreenState): void;
+        }>;
+        skills: import("pinia").Store<"skills", import("./skills").Skills, {}, {
+            setupSkillCheck(skillCheck: import("./skills").SkillCheckState, id: string): void;
+            passSkillCheck(skillCheckId: string): void;
+            failSkillCheck(skillCheckId: string): void;
+            generateSaveData(): import("./skills").Skills;
+            loadSaveData(data: import("./skills").Skills): void;
+            setupSkills(skills: {
+                [key: string]: import("..").SkillData;
+            }): void;
+            addXp(skill: string, xp: number): void;
+            incrementSkill(skill: string, amount: number): void;
+            levelledUp(skill: string): void;
+        }>;
+        dialog: import("pinia").Store<"dialog", {
+            dialog: import("./dialog-store").DialogKey[];
+        }, {}, {
+            generateSaveData(): {
+                dialog: import("./dialog-store").DialogKey[];
+            };
+            loadSaveData(data: {
+                dialog: import("./dialog-store").DialogKey[];
+            }): void;
+            addDialog(dialog: import("./dialog-store").AddDialogParams): void;
+            clearDialog(): void;
+        }>;
+        vm: import("pinia").Store<"vm", import("./vm-store").VMState, {
+            currentStack(state: {
+                stack: {
+                    currentIndex: number;
+                    branch: {
+                        code: string;
+                        args: string[];
+                        operator: string;
+                        commandType: string;
+                        options: import("../types/parser").Parser.EmptyOptions | {
+                            condition: string;
+                            success: any[];
+                            failure?: any[];
+                        } | {
+                            label: string;
+                        } | {
+                            text: string;
+                        } | {
+                            prompt: any;
+                            choices: {
+                                choice: string;
+                                branch: any[];
+                                condition?: string;
+                                skillCheck?: {
+                                    id: string;
+                                    skill: string;
+                                    value: number;
+                                    hideAfterRoll: boolean;
+                                    success: {
+                                        text: string;
+                                        branch: any[];
+                                    };
+                                    failure: {
+                                        text: string;
+                                        branch?: any[];
+                                    };
+                                };
+                                index: number;
+                            }[];
+                        } | {
+                            screen: string;
+                        } | {
+                            mode: "sound" | "music";
+                            audio: string;
+                        } | {
+                            mode: "sound" | "music";
+                            audio?: string;
+                        } | {
+                            duration: number;
+                        };
+                        fileName: string;
+                        line: number;
+                    }[];
+                    label: string;
+                }[];
+                script: import("../types/parser").Parser.ParsedScript;
+                data: import("./vm-store").DataState;
+                lastLabel: string;
+            } & import("pinia").PiniaCustomStateProperties<import("./vm-store").VMState>): {
+                currentIndex: number;
+                branch: {
+                    code: string;
+                    args: string[];
+                    operator: string;
+                    commandType: string;
+                    options: import("../types/parser").Parser.EmptyOptions | {
+                        condition: string;
+                        success: any[];
+                        failure?: any[];
+                    } | {
+                        label: string;
+                    } | {
+                        text: string;
+                    } | {
+                        prompt: any;
+                        choices: {
+                            choice: string;
+                            branch: any[];
+                            condition?: string;
+                            skillCheck?: {
+                                id: string;
+                                skill: string;
+                                value: number;
+                                hideAfterRoll: boolean;
+                                success: {
+                                    text: string;
+                                    branch: any[];
+                                };
+                                failure: {
+                                    text: string;
+                                    branch?: any[];
+                                };
+                            };
+                            index: number;
+                        }[];
+                    } | {
+                        screen: string;
+                    } | {
+                        mode: "sound" | "music";
+                        audio: string;
+                    } | {
+                        mode: "sound" | "music";
+                        audio?: string;
+                    } | {
+                        duration: number;
+                    };
+                    fileName: string;
+                    line: number;
+                }[];
+                label: string;
+            };
+            currentLine(): import("../types/parser").Parser.Command;
+        }, {
+            generateSaveData(): import("./vm-store").VMSave;
+            loadSaveData(data: import("./vm-store").VMSave): void;
+            loadScripts(scriptPaths: string[]): Promise<void>;
+            start(): void;
+            setLastLabel(label: string): void;
+            reset(): void;
+            setScript(script: import("../types/parser").Parser.ParsedScript): void;
+            overrideData(data: import("./vm-store").DataState): void;
+            setStack(stack: import("./vm-store").MachineStack): void;
+            setData(path: string, value: any): void;
+            addInstruction(path: string, value: any): void;
+            addStack(newStack: Partial<import("./vm-store").MachineStack>): void;
+            nextLine(): Promise<any>;
+            previousStack(): void;
+            finishGame(): void;
+            runLine(): Promise<void>;
+            runLabel(label: string): void;
+        }>;
+        hud: import("pinia").Store<"hud", import("./hud-stats-store").HudState, {}, {
+            setupHudStats(stats: {
+                [key: string]: import("..").HudStatConfig;
+            }): void;
+            setStat(stat: string, value: number): void;
+            addStat(stat: string, value: number): void;
+            generateSaveData(): import("./hud-stats-store").HudState;
+            loadSaveData(data: import("./hud-stats-store").HudState): void;
+        }>;
+        audio: import("pinia").Store<"audio", import("./audio-store").AudioState, {}, {
+            stopMusic(): void;
+            setMusic(music: string, soundId: number): void;
+            generateSaveData(): import("./audio-store").AudioSave;
+            loadSaveData(data: import("./audio-store").AudioSave): void;
+        }>;
+        rendering: import("pinia").Store<"rendering", import("./rendering-store").RenderingState, {}, {
+            updateScreenSize(width: number, height: number, textWidth: number): void;
+        }>;
+        notifications: import("pinia").Store<"notifications", import("./notification-store").NotificationsState, {}, {
+            addNotification(text: string): Promise<void>;
+            deleteNotification(id: string): void;
+        }>;
+    };
+    overrideStates(override: any): void;
+}>;
+export {};

package/lib/stores/notification-store.d.ts

@@ -0,0 +1,12 @@
+export interface NotificationState {
+    text: string;
+}
+export interface NotificationsState {
+    notifications: {
+        [key: string]: NotificationState;
+    };
+}
+export declare const useNotifications: import("pinia").StoreDefinition<"notifications", NotificationsState, {}, {
+    addNotification(text: string): Promise<void>;
+    deleteNotification(id: string): void;
+}>;

package/lib/stores/rendering-store.d.ts

@@ -0,0 +1,13 @@
+export interface RenderingState {
+    screenWidth: number;
+    screenHeight: number;
+    canvasWidth: number;
+    canvasHeight: number;
+    renderRatio: number;
+    topOffset: number;
+    leftOffset: number;
+    layoutMode: 'horizontal' | 'vertical';
+}
+export declare const useRenderingStore: import("pinia").StoreDefinition<"rendering", RenderingState, {}, {
+    updateScreenSize(width: number, height: number, textWidth: number): void;
+}>;

package/lib/stores/screens-store.d.ts

@@ -0,0 +1,23 @@
+import { ButtonConfig } from '..';
+export interface ButtonsState {
+    [key: string]: {
+        enabled: boolean;
+    };
+}
+export interface ScreenState {
+    currentScreen: string;
+    buttons: ButtonsState;
+}
+export declare type ScreenSave = ScreenState;
+export declare const useScreens: import("pinia").StoreDefinition<"screens", {
+    currentScreen: string;
+    buttons: ButtonsState;
+}, {}, {
+    setScreen(screen: string): void;
+    setButtons(buttons: {
+        [key: string]: ButtonConfig;
+    }): void;
+    changeButton(button: string, newValue: boolean): void;
+    generateSaveData(): ScreenSave;
+    loadSaveData(data: ScreenSave): void;
+}>;

package/lib/stores/skills.d.ts

@@ -0,0 +1,32 @@
+import { SkillData } from '..';
+export interface SkillState {
+    level: number;
+    xp: number;
+}
+export interface SkillsState {
+    [key: string]: SkillState;
+}
+export interface SkillCheckState {
+    passed: boolean;
+    available: boolean;
+}
+export interface Skills {
+    skillChecks: {
+        [key: string]: SkillCheckState;
+    };
+    skills: SkillsState;
+}
+export declare type SkillsSave = Skills;
+export declare const useSkills: import("pinia").StoreDefinition<"skills", Skills, {}, {
+    setupSkillCheck(skillCheck: SkillCheckState, id: string): void;
+    passSkillCheck(skillCheckId: string): void;
+    failSkillCheck(skillCheckId: string): void;
+    generateSaveData(): SkillsSave;
+    loadSaveData(data: SkillsSave): void;
+    setupSkills(skills: {
+        [key: string]: SkillData;
+    }): void;
+    addXp(skill: string, xp: number): void;
+    incrementSkill(skill: string, amount: number): void;
+    levelledUp(skill: string): void;
+}>;

package/lib/stores/vm-store.d.ts

@@ -0,0 +1,151 @@
+import { Parser } from '@/types/parser';
+export declare type AddStackOptions = Partial<MachineStack>;
+export interface MachineStack {
+    currentIndex: number;
+    branch: Parser.Branch;
+    label: string;
+}
+export interface DataState {
+    [key: string]: any;
+}
+export interface VMState {
+    stack: MachineStack[];
+    script: Parser.ParsedScript;
+    data: DataState;
+    lastLabel: string;
+}
+export interface VMSave {
+    lastLabel: string;
+    data: DataState;
+}
+export declare const useVM: import("pinia").StoreDefinition<"vm", VMState, {
+    currentStack(state: {
+        stack: {
+            currentIndex: number;
+            branch: {
+                code: string;
+                args: string[];
+                operator: string;
+                commandType: string;
+                options: Parser.EmptyOptions | {
+                    condition: string;
+                    success: any[];
+                    failure?: any[];
+                } | {
+                    label: string;
+                } | {
+                    text: string;
+                } | {
+                    prompt: any;
+                    choices: {
+                        choice: string;
+                        branch: any[];
+                        condition?: string;
+                        skillCheck?: {
+                            id: string;
+                            skill: string;
+                            value: number;
+                            hideAfterRoll: boolean;
+                            success: {
+                                text: string;
+                                branch: any[];
+                            };
+                            failure: {
+                                text: string;
+                                branch?: any[];
+                            };
+                        };
+                        index: number;
+                    }[];
+                } | {
+                    screen: string;
+                } | {
+                    mode: "sound" | "music";
+                    audio: string;
+                } | {
+                    mode: "sound" | "music";
+                    audio?: string;
+                } | {
+                    duration: number;
+                };
+                fileName: string;
+                line: number;
+            }[];
+            label: string;
+        }[];
+        script: Parser.ParsedScript;
+        data: DataState;
+        lastLabel: string;
+    } & import("pinia").PiniaCustomStateProperties<VMState>): {
+        currentIndex: number;
+        branch: {
+            code: string;
+            args: string[];
+            operator: string;
+            commandType: string;
+            options: Parser.EmptyOptions | {
+                condition: string;
+                success: any[];
+                failure?: any[];
+            } | {
+                label: string;
+            } | {
+                text: string;
+            } | {
+                prompt: any;
+                choices: {
+                    choice: string;
+                    branch: any[];
+                    condition?: string;
+                    skillCheck?: {
+                        id: string;
+                        skill: string;
+                        value: number;
+                        hideAfterRoll: boolean;
+                        success: {
+                            text: string;
+                            branch: any[];
+                        };
+                        failure: {
+                            text: string;
+                            branch?: any[];
+                        };
+                    };
+                    index: number;
+                }[];
+            } | {
+                screen: string;
+            } | {
+                mode: "sound" | "music";
+                audio: string;
+            } | {
+                mode: "sound" | "music";
+                audio?: string;
+            } | {
+                duration: number;
+            };
+            fileName: string;
+            line: number;
+        }[];
+        label: string;
+    };
+    currentLine(): Parser.Command;
+}, {
+    generateSaveData(): VMSave;
+    loadSaveData(data: VMSave): void;
+    loadScripts(scriptPaths: string[]): Promise<void>;
+    start(): void;
+    setLastLabel(label: string): void;
+    reset(): void;
+    setScript(script: Parser.ParsedScript): void;
+    overrideData(data: DataState): void;
+    setStack(stack: MachineStack): void;
+    setData(path: string, value: any): void;
+    addInstruction(path: string, value: any): void;
+    addStack(newStack: AddStackOptions): void;
+    nextLine(): Promise<any>;
+    previousStack(): void;
+    finishGame(): void;
+    runLine(): Promise<void>;
+    runLabel(label: string): void;
+}>;

package/lib/types/dialog-box-types.d.ts

@@ -1,4 +1,4 @@
-import { DialogChoice } from './state';
+import { DialogChoice } from '@/stores/dialog-store';
 export interface DialogBoxParameters {
     title: string;
     text: string;

package/lib/types/game-save.d.ts

@@ -1,17 +1,17 @@
-import { ButtonsState, HudStatsState, DataState, DialogKey, SkillCheckState, SkillsState } from './state';
-export interface GameSave {
-    data: DataState;
-    skills: SkillsState;
-    dialog: DialogKey[];
-    lastLabel: string;
-    buttons: ButtonsState;
-    skillChecks: {
-        [key: string]: SkillCheckState;
-    };
-    playTime: number;
-    hudStats: HudStatsState;
-    audio: {
-        currentMusic?: string;
-    };
-    currentScreen: string;
-}
+import { AudioSave } from '@/stores/audio-store';
+import { DialogSave } from '@/stores/dialog-store';
+import { HudSave } from '@/stores/hud-stats-store';
+import { MainSaveData } from '@/stores/main-store';
+import { ScreenSave } from '@/stores/screens-store';
+import { SkillsSave } from '@/stores/skills';
+import { VMSave } from '@/stores/vm-store';
+export declare type GameSave = {
+    version: string;
+    skills: SkillsSave;
+    screen: ScreenSave;
+    main: MainSaveData;
+    dialog: DialogSave;
+    vm: VMSave;
+    audio: AudioSave;
+    hud: HudSave;
+};