narrat 2.9.3 → 2.10.1

package/dist/config.d.ts

@@ -1,164 +1,182 @@
-import { AppOptions } from './types/app-types';
-import { Config } from './config/config-output';
-import { ScreenConfig } from './config/screens-config';
-import { ButtonConfig } from './config/buttons-config';
-import { ConfigInput } from './config/config-input';
-export declare function setupConfig(configInput: ConfigInput): Promise<Config>;
-export declare function loadConfig(options: AppOptions): Promise<Config>;
-export declare function getConfig(): Config;
-export declare function audioConfig(): import("./config/audio-config").AudioConfig;
-export declare function skillsConfig(): {
-    skills: Record<string, {
-        hidden?: boolean | undefined;
-        description: string;
-        name: string;
-        startingLevel: number;
-        icon: string;
-    }>;
-    skillChecks: {
-        rollRange: number;
-        skillMultiplier: number;
-        failureChance: number;
-        difficultyText: [number, string][];
-    };
-    skillOptions: {
-        xpPerLevel: number;
-        notifyLevelUp: boolean;
-    };
-};
-export declare function itemsConfig(): {
-    items: Record<string, {
-        onUse?: {
-            label: string;
-            action: string;
-        } | undefined;
-        tag?: string | undefined;
-        category?: string | undefined;
-        showIfEmpty?: boolean | undefined;
-        description: string;
-        name: string;
-        icon: string;
-    }>;
-    categories: {
-        title: string;
-        id: string;
-    }[];
-};
-export declare function questsConfig(): {
-    quests: Record<string, {
-        category?: string | undefined;
-        title: string;
-        description: string;
-        objectives: Record<string, {
-            hidden?: boolean | undefined;
-            description: string;
-        }>;
-    }>;
-    categories: {
-        title: string;
-        id: string;
-    }[];
-};
-export declare function screensConfig(): {
-    screens: Record<string, {
-        buttons?: (string | ({
-            anchor?: {
-                x: number;
-                y: number;
-            } | undefined;
-            text?: string | undefined;
-            action?: string | undefined;
-            tag?: string | undefined;
-            cssClass?: string | undefined;
-            background?: string | undefined;
-            actionType?: string | undefined;
-            enabled: boolean;
-            position: {
-                width?: number | undefined;
-                height?: number | undefined;
-                left: number;
-                top: number;
-            };
-        } & {
-            id: string;
-        }))[] | undefined;
-        background: string;
-    }>;
-};
-export declare function buttonsConfig(): {
-    buttons: Record<string, {
-        anchor?: {
-            x: number;
-            y: number;
-        } | undefined;
-        text?: string | undefined;
-        action?: string | undefined;
-        tag?: string | undefined;
-        cssClass?: string | undefined;
-        background?: string | undefined;
-        actionType?: string | undefined;
-        enabled: boolean;
-        position: {
-            width?: number | undefined;
-            height?: number | undefined;
-            left: number;
-            top: number;
-        };
-    }>;
-};
-export declare function tooltipsConfig(): {
-    options: {
-        delay?: number | undefined;
-        width: number;
-        keywordsPrefix: string;
-    };
-    tooltips: {
-        title: string;
-        description: string;
-        keywords: string[];
-    }[];
-};
-export declare function getTooltipConfig(keyword: string): {
-    title: string;
-    description: string;
-    keywords: string[];
-} | null;
-export declare function getSkillConfig(id: string): {
-    hidden?: boolean | undefined;
-    description: string;
-    name: string;
-    startingLevel: number;
-    icon: string;
-};
-export declare function getImageUrl(imageKeyOrUrl: string): string;
-export declare function getAssetUrl(assetPath: string): string;
-export declare function getSplitConfigUrl(basePath: string, url: string): string;
-export declare function getDataUrl(dataPath: string): string;
-export declare function getButtonConfig(button: string): ButtonConfig;
-export declare function getScreenConfig(screen: string): ScreenConfig;
-export declare function getItemConfig(id: string): {
-    onUse?: {
-        label: string;
-        action: string;
-    } | undefined;
-    tag?: string | undefined;
-    category?: string | undefined;
-    showIfEmpty?: boolean | undefined;
-    description: string;
-    name: string;
-    icon: string;
-};
-export declare function getQuestConfig(questId: string): {
-    category?: string | undefined;
-    title: string;
-    description: string;
-    objectives: Record<string, {
-        hidden?: boolean | undefined;
-        description: string;
-    }>;
-};
-export declare function getObjectiveConfig(quest: string, objectiveId: string): {
-    hidden?: boolean | undefined;
-    description: string;
-};
-export declare function getDialogPanelWidth(): number;
+import { AppOptions } from './types/app-types';
+import { Config } from './config/config-output';
+import { ScreenConfig } from './config/screens-config';
+import { ButtonConfig } from './config/buttons-config';
+import { ConfigInput } from './config/config-input';
+export declare function setupConfig(configInput: ConfigInput): Promise<Config>;
+export declare function loadConfig(options: AppOptions): Promise<Config>;
+export declare function getConfig(): Config;
+export declare function audioConfig(): import("./config/audio-config").AudioConfig;
+export declare function skillsConfig(): {
+    skills: Record<string, {
+        hidden?: boolean | undefined;
+        description: string;
+        name: string;
+        startingLevel: number;
+        icon: string;
+    }>;
+    skillChecks: {
+        rollRange: number;
+        skillMultiplier: number;
+        failureChance: number;
+        difficultyText: [number, string][];
+    };
+    skillOptions: {
+        xpPerLevel: number;
+        notifyLevelUp: boolean;
+    };
+};
+export declare function itemsConfig(): {
+    items: Record<string, {
+        onUse?: {
+            label: string;
+            action: string;
+        } | undefined;
+        tag?: string | undefined;
+        category?: string | undefined;
+        showIfEmpty?: boolean | undefined;
+        description: string;
+        name: string;
+        icon: string;
+    }>;
+    categories: {
+        title: string;
+        id: string;
+    }[];
+};
+export declare function questsConfig(): {
+    quests: Record<string, {
+        category?: string | undefined;
+        title: string;
+        description: string;
+        objectives: Record<string, {
+            hidden?: boolean | undefined;
+            description: string;
+        }>;
+    }>;
+    categories: {
+        title: string;
+        id: string;
+    }[];
+};
+export declare function screensConfig(): {
+    screens: Record<string, {
+        buttons?: (string | ({
+            anchor?: {
+                x: number;
+                y: number;
+            } | undefined;
+            text?: string | undefined;
+            action?: string | undefined;
+            tag?: string | undefined;
+            cssClass?: string | undefined;
+            background?: string | undefined;
+            actionType?: string | undefined;
+            scriptClickable?: boolean | undefined;
+            enabled: boolean;
+            position: {
+                width?: number | undefined;
+                height?: number | undefined;
+                left: number;
+                top: number;
+            };
+        } & {
+            id: string;
+        }))[] | undefined;
+        background: string;
+    }>;
+};
+export declare function buttonsConfig(): {
+    clickableDuringScriptsByDefault?: boolean | undefined;
+    buttons: Record<string, {
+        anchor?: {
+            x: number;
+            y: number;
+        } | undefined;
+        text?: string | undefined;
+        action?: string | undefined;
+        tag?: string | undefined;
+        cssClass?: string | undefined;
+        background?: string | undefined;
+        actionType?: string | undefined;
+        scriptClickable?: boolean | undefined;
+        enabled: boolean;
+        position: {
+            width?: number | undefined;
+            height?: number | undefined;
+            left: number;
+            top: number;
+        };
+    }>;
+};
+export declare function tooltipsConfig(): {
+    options: {
+        delay?: number | undefined;
+        width: number;
+        keywordsPrefix: string;
+    };
+    tooltips: {
+        title: string;
+        description: string;
+        keywords: string[];
+    }[];
+};
+export declare function charactersConfig(): {
+    config: {
+        imagesPath: string;
+    };
+    characters: Record<string, {
+        style?: {
+            color?: string | undefined;
+            boxCss?: Record<string, any> | undefined;
+            nameCss?: Record<string, any> | undefined;
+            textCss?: Record<string, any> | undefined;
+        } | undefined;
+        sprites?: Record<string, string> | undefined;
+        name: string;
+    }>;
+};
+export declare function getTooltipConfig(keyword: string): {
+    title: string;
+    description: string;
+    keywords: string[];
+} | null;
+export declare function getSkillConfig(id: string): {
+    hidden?: boolean | undefined;
+    description: string;
+    name: string;
+    startingLevel: number;
+    icon: string;
+};
+export declare function getImageUrl(imageKeyOrUrl: string): string;
+export declare function getAssetUrl(assetPath: string): string;
+export declare function getSplitConfigUrl(basePath: string, url: string): string;
+export declare function getDataUrl(dataPath: string): string;
+export declare function getButtonConfig(button: string): ButtonConfig;
+export declare function getScreenConfig(screen: string): ScreenConfig;
+export declare function getItemConfig(id: string): {
+    onUse?: {
+        label: string;
+        action: string;
+    } | undefined;
+    tag?: string | undefined;
+    category?: string | undefined;
+    showIfEmpty?: boolean | undefined;
+    description: string;
+    name: string;
+    icon: string;
+};
+export declare function getQuestConfig(questId: string): {
+    category?: string | undefined;
+    title: string;
+    description: string;
+    objectives: Record<string, {
+        hidden?: boolean | undefined;
+        description: string;
+    }>;
+};
+export declare function getObjectiveConfig(quest: string, objectiveId: string): {
+    hidden?: boolean | undefined;
+    description: string;
+};
+export declare function getDialogPanelWidth(): number;

package/dist/constants.d.ts

@@ -1,12 +1,12 @@
-export declare const SAVE_FILE = "gameSave";
-export declare const PRE_SIGNAL = "###_--_~=:;";
-export declare const JUMP_SIGNAL = "###_--_~=:;_JUMP";
-export declare const RETURN_SIGNAL = "###_--_~=:;_RETURN";
-export declare const OK_SIGNAL = "###_--_~=:;_OK";
-export declare const STOP_SIGNAL = "###_--_~=:;_STOP";
-export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | typeof OK_SIGNAL | typeof STOP_SIGNAL;
-export declare function isReturnSignal(s: string): s is ReturnSignal;
-export declare const VERSION: string;
-export declare const BUILD_DATE: Date;
-export declare const DEFAULT_DIALOG_WIDTH = 400;
-export declare const DEFAULT_TEXT_SPEED = 20;
+export declare const SAVE_FILE = "gameSave";
+export declare const PRE_SIGNAL = "###_--_~=:;";
+export declare const JUMP_SIGNAL = "###_--_~=:;_JUMP";
+export declare const RETURN_SIGNAL = "###_--_~=:;_RETURN";
+export declare const OK_SIGNAL = "###_--_~=:;_OK";
+export declare const STOP_SIGNAL = "###_--_~=:;_STOP";
+export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | typeof OK_SIGNAL | typeof STOP_SIGNAL;
+export declare function isReturnSignal(s: string): s is ReturnSignal;
+export declare const VERSION: string;
+export declare const BUILD_DATE: Date;
+export declare const DEFAULT_DIALOG_WIDTH = 400;
+export declare const DEFAULT_TEXT_SPEED = 20;

package/dist/demo/demo.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/dialog-box.vue.d.ts

@@ -1,71 +1,71 @@
-/// <reference types="node" />
-import { PropType } from 'vue';
-import { DialogChoice } from './stores/dialog-store';
-import { DialogStyle } from './types/character-types';
-import { DialogBoxParameters } from './types/dialog-box-types';
-export interface TextAnimation {
-    text: string;
-    index: number;
-    startTime: number;
-    timer: NodeJS.Timer | null;
-    skippedChars: number;
-    tags: RegExpExecArray[];
-    finished: boolean;
-}
-declare const _default: import("vue").DefineComponent<{
-    options: {
-        type: PropType<DialogBoxParameters>;
-        required: true;
-    };
-    active: BooleanConstructor;
-}, unknown, {
-    playerText: string;
-    passed: boolean;
-    timeout: any;
-    textAnimation: TextAnimation | null;
-    mounted: boolean;
-    autoTimer: NodeJS.Timer | null;
-    skipTimer: NodeJS.Timer | null;
-    nextLineTimer: NodeJS.Timer | null;
-}, {
-    preText(): string;
-    style(): DialogStyle;
-    dialogBoxStyle(): any;
-    isBasicChoice(): boolean;
-    dialogBoxClass(): false | "dialog-box-followup";
-    titleStyle(): any;
-    textStyle(): any;
-    text(): string;
-    choices(): DialogChoice[] | undefined;
-    skipping(): boolean;
-    canInteract(): boolean;
-    paused: () => boolean;
-}, {
-    clearListeners(): void;
-    keyboardEvent(e: KeyboardEvent): void;
-    next(): void;
-    chooseOption(choice: DialogChoice | number): void;
-    finishLine(): void;
-    dialogStyle(choice: DialogChoice): any;
-    dialogClass(choice: DialogChoice): "strike-anim" | undefined;
-    submitText(): void;
-    addTextSection(start: number, end: number): number;
-    addHtmlTag(tag: RegExpExecArray): number;
-    startTextAnimation(): void;
-    startSkip(): void;
-    updateTextAnimation(): void;
-    endTextAnimation({ unmounted, pressedSpace, }?: {
-        unmounted?: boolean | undefined;
-        pressedSpace?: boolean | undefined;
-    }): void;
-    registerKeyboardShortcuts(): void;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    options: {
-        type: PropType<DialogBoxParameters>;
-        required: true;
-    };
-    active: BooleanConstructor;
-}>>, {
-    active: boolean;
-}>;
-export default _default;
+/// <reference types="node" />
+import { PropType } from 'vue';
+import { DialogStyleConfig } from './config/characters-config';
+import { DialogChoice } from './stores/dialog-store';
+import { DialogBoxParameters } from './types/dialog-box-types';
+export interface TextAnimation {
+    text: string;
+    index: number;
+    startTime: number;
+    timer: NodeJS.Timer | null;
+    skippedChars: number;
+    tags: RegExpExecArray[];
+    finished: boolean;
+}
+declare const _default: import("vue").DefineComponent<{
+    options: {
+        type: PropType<DialogBoxParameters>;
+        required: true;
+    };
+    active: BooleanConstructor;
+}, unknown, {
+    playerText: string;
+    passed: boolean;
+    timeout: any;
+    textAnimation: TextAnimation | null;
+    mounted: boolean;
+    autoTimer: NodeJS.Timer | null;
+    skipTimer: NodeJS.Timer | null;
+    nextLineTimer: NodeJS.Timer | null;
+}, {
+    preText(): string;
+    style(): DialogStyleConfig;
+    dialogBoxStyle(): any;
+    isBasicChoice(): boolean;
+    dialogBoxClass(): false | "dialog-box-followup";
+    titleStyle(): any;
+    textStyle(): any;
+    text(): string;
+    choices(): DialogChoice[] | undefined;
+    skipping(): boolean;
+    canInteract(): boolean;
+    paused: () => boolean;
+}, {
+    clearListeners(): void;
+    keyboardEvent(e: KeyboardEvent): void;
+    next(): void;
+    chooseOption(choice: DialogChoice | number): void;
+    finishLine(): void;
+    dialogStyle(choice: DialogChoice): any;
+    dialogClass(choice: DialogChoice): "strike-anim" | undefined;
+    submitText(): void;
+    addTextSection(start: number, end: number): number;
+    addHtmlTag(tag: RegExpExecArray): number;
+    startTextAnimation(): void;
+    startSkip(): void;
+    updateTextAnimation(): void;
+    endTextAnimation({ unmounted, pressedSpace, }?: {
+        unmounted?: boolean | undefined;
+        pressedSpace?: boolean | undefined;
+    }): void;
+    registerKeyboardShortcuts(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    options: {
+        type: PropType<DialogBoxParameters>;
+        required: true;
+    };
+    active: BooleanConstructor;
+}>>, {
+    active: boolean;
+}>;
+export default _default;

package/dist/exports/components.d.ts

@@ -1,2 +1,2 @@
-import ModalWindow from '../components/utils/modal-window.vue';
-export { ModalWindow };
+import ModalWindow from '../components/utils/modal-window.vue';
+export { ModalWindow };

package/dist/exports/config.d.ts

@@ -1 +1 @@
-export { getConfig } from '../config';
+export { getConfig } from '../config';

package/dist/exports/display.d.ts

@@ -1,2 +1,2 @@
-import { aspectRatioFit } from '../utils/helpers';
-export { aspectRatioFit };
+import { aspectRatioFit } from '../utils/helpers';
+export { aspectRatioFit };

package/dist/exports/events.d.ts

@@ -1 +1 @@
-export { inputEvents } from '../utils/InputsListener';
+export { inputEvents } from '../utils/InputsListener';

package/dist/exports/others.d.ts

@@ -1 +1 @@
-export { registerMenuButton } from '../menu-buttons/menu-buttons';
+export { registerMenuButton } from '../menu-buttons/menu-buttons';

package/dist/exports/plugins.d.ts

@@ -1,38 +1,47 @@
-import { NarratPlugin } from '../plugins/NarratPlugin';
-import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
-import type { CommandRunner } from '../vm/commands/command-plugin';
-import { StoreDefinition } from 'pinia';
-import { MenuState } from '../stores/menu-store';
-export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
-export interface NarratCustomStoreActions {
-    save?: () => any;
-    load?: (data: any) => void;
-    setup?: () => Promise<void>;
-    start?: () => void;
-    reset: () => void;
-}
-export declare type UseCustomStore = StoreDefinition<string, any, any, NarratCustomStoreActions>;
-export interface CustomStores {
-    [key: string]: UseCustomStore;
-}
-export interface CustomMenuButton {
-    config: MenuState;
-    component: any;
-}
-export declare type NarratPluginObject<T> = {
-    onPageLoaded?: NarratLifecycleHook;
-    onNarratSetup?: NarratLifecycleHook;
-    onAppMounted?: NarratLifecycleHook;
-    onAssetsLoaded?: NarratLifecycleHook;
-    onGameSetup?: NarratLifecycleHook;
-    onGameStart?: NarratLifecycleHook;
-    onGameMounted?: NarratLifecycleHook;
-    onGameUnmounted?: NarratLifecycleHook;
-    customCommands?: CommandPlugin<T>[];
-    customStores?: CustomStores;
-    customMenuButtons?: CustomMenuButton[];
-};
-declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
-declare function addCommand<T>(command: CommandPlugin<T>): void;
-export { CommandRunner };
-export { CommandPlugin, NarratPlugin, registerPlugin, addCommand, generateParser, };
+import { NarratPlugin } from '../plugins/NarratPlugin';
+import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
+import type { CommandRunner } from '../vm/commands/command-plugin';
+import { StoreDefinition } from 'pinia';
+import { MenuState, MenuTabState } from '../stores/menu-store';
+export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+export interface NarratCustomStoreActions {
+    save?: () => any;
+    load?: (data: any) => void;
+    setup?: () => Promise<void>;
+    start?: () => void;
+    reset: () => void;
+}
+export declare type UseCustomStore = StoreDefinition<string, any, any, NarratCustomStoreActions>;
+export interface CustomStores {
+    [key: string]: UseCustomStore;
+}
+export interface CustomMenuButton {
+    menuId: string;
+    config: MenuState;
+    components: {
+        [key: string]: any;
+    };
+}
+export interface CustomMenuTab {
+    menuId: string;
+    config: MenuTabState;
+    component: any;
+}
+export declare type NarratPluginObject<T> = {
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin<T>[];
+    customStores?: CustomStores;
+    customMenuButtons?: CustomMenuButton[];
+    customMenuTabs?: CustomMenuTab[];
+};
+declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
+declare function addCommand<T>(command: CommandPlugin<T>): void;
+export { CommandRunner };
+export { CommandPlugin, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/dist/exports/stores.d.ts

@@ -1,11 +1,11 @@
-export { useMain } from '../stores/main-store';
-export { useAudio } from '../stores/audio-store';
-export { useDialogStore } from '../stores/dialog-store';
-export { useHud } from '../stores/hud-stats-store';
-export { useInventory } from '../stores/inventory-store';
-export { useNotifications } from '../stores/notification-store';
-export { useQuests } from '../stores/quest-log';
-export { useRenderingStore } from '../stores/rendering-store';
-export { useScreens } from '../stores/screens-store';
-export { useSkills } from '../stores/skills';
-export { useVM } from '../stores/vm-store';
+export { useMain } from '../stores/main-store';
+export { useAudio } from '../stores/audio-store';
+export { useDialogStore } from '../stores/dialog-store';
+export { useHud } from '../stores/hud-stats-store';
+export { useInventory } from '../stores/inventory-store';
+export { useNotifications } from '../stores/notification-store';
+export { useQuests } from '../stores/quest-log';
+export { useRenderingStore } from '../stores/rendering-store';
+export { useScreens } from '../stores/screens-store';
+export { useSkills } from '../stores/skills';
+export { useVM } from '../stores/vm-store';