narrat 2.3.0 → 2.3.1

package/dist/components/volume-controls.vue.d.ts

@@ -1,18 +1,18 @@
-import { AudioModeKey } from '../stores/audio-store';
-declare const _default: import("vue").DefineComponent<{}, {}, {
-    muted: boolean;
-    volumes: {
-        mode: 'master' | AudioModeKey;
-        volume: number;
-    }[];
-    modeNames: {
-        master: string;
-        music: string;
-        ambiant: string;
-        sound: string;
-    };
-}, {}, {
-    changeVolume(mode: 'master' | AudioModeKey, event: Event): void;
-    toggleMute(): void;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
-export default _default;
+import { AudioModeKey } from '../stores/audio-store';
+declare const _default: import("vue").DefineComponent<{}, {}, {
+    muted: boolean;
+    volumes: {
+        mode: 'master' | AudioModeKey;
+        volume: number;
+    }[];
+    modeNames: {
+        master: string;
+        music: string;
+        ambiant: string;
+        sound: string;
+    };
+}, {}, {
+    changeVolume(mode: 'master' | AudioModeKey, event: Event): void;
+    toggleMute(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/dist/config.d.ts

@@ -1,194 +1,181 @@
-import { TransitionSettings } from './utils/transition';
-export declare function setConfig(conf: Config): void;
-export declare function getConfig(): Config;
-export declare function getSkillConfig(id: string): SkillData;
-export declare function getImageUrl(imageKeyOrUrl: string): string;
-export declare function getAssetUrl(assetPath: string): string;
-export declare function getDataUrl(dataPath: string): string;
-export declare function getButtonConfig(button: string): ButtonConfig;
-export declare function getItemConfig(id: string): ItemData;
-export declare function getQuestConfig(questId: string): QuestData;
-export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
-export interface AppOptionsDeprecated {
-    logging: boolean;
-    debug: boolean;
-}
-export interface Config {
-    baseAssetsPath?: string;
-    baseDataPath?: string;
-    gameTitle: string;
-    images: {
-        [key: string]: string;
-    };
-    layout: {
-        backgrounds: {
-            width: number;
-            height: number;
-        };
-        dialogBottomPadding: number;
-        minTextWidth: number;
-        mobileDialogHeightPercentage: number;
-        verticalLayoutThreshold: number;
-        portraits: {
-            width: number;
-            height: number;
-        };
-    };
-    gameFlow: {
-        labelToJumpOnScriptEnd?: string;
-    };
-    splashScreens: {
-        engineSplashScreen?: {
-            skip?: boolean;
-            fadeDuration?: number;
-            timeBeforeFadeout?: number;
-            overrideText?: string;
-            overrideLogo?: string;
-        };
-        gameSplashScreen?: {
-            startButtonText?: string;
-        };
-    };
-    screens: {
-        [key: string]: ScreenConfig;
-    };
-    buttons: {
-        [key: string]: ButtonConfig;
-    };
-    skills: {
-        [key: string]: SkillData;
-    };
-    skillOptions: {
-        xpPerLevel: number;
-        notifyLevelUp: boolean;
-    };
-    skillChecks: {
-        rollRange: number;
-        skillMultiplier: number;
-        failureChance: number;
-        difficultyText: Array<[number, string]>;
-    };
-    scripts: string[];
-    audio: {
-        [key: string]: AudioConfig;
-    };
-    audioOptions: {
-        volume: number;
-        defaultMusic?: string;
-        musicFadeInTime: number;
-        musicFadeInDelay: number;
-        musicFadeOutTime: number;
-    };
-    sound?: {
-        [key: string]: AudioConfig;
-    };
-    music?: {
-        [key: string]: AudioConfig;
-    };
-    notifications: {
-        timeOnScreen: number;
-        alsoPrintInDialogue?: boolean;
-    };
-    hudStats: {
-        [key: string]: HudStatConfig;
-    };
-    items: {
-        [key: string]: ItemData;
-    };
-    interactionTags: {
-        [key: string]: {
-            onlyInteractOutsideOfScripts: boolean;
-        };
-    };
-    quests: {
-        [key: string]: QuestData;
-    };
-    transitions: {
-        [key: string]: TransitionSettings;
-    };
-    audioTriggers: {
-        [key: string]: string;
-    };
-    menuButtons: {
-        [key: string]: MenuButtonData;
-    };
-    debugging: {
-        showScriptFinishedMessage?: boolean;
-    };
-    saves: {
-        mode: 'game-slots' | 'manual';
-    };
-}
-export interface ScreenConfig {
-    background: string;
-    buttons: Array<string | InlineButtonConfig>;
-}
-export interface MenuButtonData {
-    text: string;
-}
-export interface QuestData {
-    title: string;
-    description: string;
-    objectives: {
-        [key: string]: ObjectiveData;
-    };
-}
-export interface ObjectiveData {
-    description: string;
-    hidden?: boolean;
-}
-export interface ItemData {
-    name: string;
-    description: string;
-    icon: string;
-    onUse?: {
-        action: 'jump' | 'run';
-        label: string;
-    };
-    tag?: string;
-}
-export interface HudStatConfig {
-    name: string;
-    icon: string;
-    startingValue: number;
-    minValue?: number;
-    maxValue?: number;
-}
-export interface AudioConfig {
-    src: string;
-    path?: string;
-    volume?: number;
-    rate?: number;
-    html5?: boolean;
-}
-export interface MusicConfig extends AudioConfig {
-    loop?: boolean;
-}
-export interface ButtonConfig {
-    enabled: boolean;
-    background?: string;
-    text?: string;
-    position: {
-        left: number;
-        top: number;
-        width?: number;
-        height?: number;
-    };
-    anchor?: {
-        x: number;
-        y: number;
-    };
-    action: string;
-    actionType?: 'jump' | 'run';
-    tag?: string;
-}
-export interface InlineButtonConfig extends ButtonConfig {
-    id: string;
-}
-export interface SkillData {
-    name: string;
-    description: string;
-    startingLevel: number;
-    hidden?: boolean;
-    icon: string;
-}
+import { TransitionSettings } from './utils/transition';
+export declare function setConfig(conf: Config): void;
+export declare function getConfig(): Config;
+export declare function getSkillConfig(id: string): SkillData;
+export declare function getImageUrl(imageKeyOrUrl: string): string;
+export declare function getAssetUrl(assetPath: string): string;
+export declare function getButtonConfig(button: string): ButtonConfig;
+export declare function getItemConfig(id: string): ItemData;
+export declare function getQuestConfig(questId: string): QuestData;
+export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
+export interface AppOptions {
+    baseAssetsPath?: string;
+    logging: boolean;
+    debug: boolean;
+}
+export interface Config {
+    baseAssetsPath?: string;
+    gameTitle: string;
+    images: {
+        [key: string]: string;
+    };
+    layout: {
+        backgrounds: {
+            width: number;
+            height: number;
+        };
+        dialogBottomPadding: number;
+        minTextWidth: number;
+        mobileDialogHeightPercentage: number;
+        verticalLayoutThreshold: number;
+        portraits: {
+            width: number;
+            height: number;
+        };
+    };
+    gameFlow: {
+        labelToJumpOnScriptEnd?: string;
+    };
+    screens: {
+        [key: string]: ScreenConfig;
+    };
+    buttons: {
+        [key: string]: ButtonConfig;
+    };
+    skills: {
+        [key: string]: SkillData;
+    };
+    skillOptions: {
+        xpPerLevel: number;
+        notifyLevelUp: boolean;
+    };
+    skillChecks: {
+        rollRange: number;
+        skillMultiplier: number;
+        failureChance: number;
+        difficultyText: Array<[number, string]>;
+    };
+    scripts: string[];
+    audio: {
+        [key: string]: AudioConfig;
+    };
+    audioOptions: {
+        volume: number;
+        defaultMusic?: string;
+        musicFadeInTime: number;
+        musicFadeInDelay: number;
+        musicFadeOutTime: number;
+    };
+    sound?: {
+        [key: string]: AudioConfig;
+    };
+    music?: {
+        [key: string]: AudioConfig;
+    };
+    notifications: {
+        timeOnScreen: number;
+        alsoPrintInDialogue?: boolean;
+    };
+    hudStats: {
+        [key: string]: HudStatConfig;
+    };
+    items: {
+        [key: string]: ItemData;
+    };
+    interactionTags: {
+        [key: string]: {
+            onlyInteractOutsideOfScripts: boolean;
+        };
+    };
+    quests: {
+        [key: string]: QuestData;
+    };
+    transitions: {
+        [key: string]: TransitionSettings;
+    };
+    audioTriggers: {
+        [key: string]: string;
+    };
+    menuButtons: {
+        [key: string]: MenuButtonData;
+    };
+    debugging: {
+        showScriptFinishedMessage?: boolean;
+    };
+    saves: {
+        mode: 'game-slots' | 'manual';
+    };
+}
+export interface ScreenConfig {
+    background: string;
+    buttons: Array<string | InlineButtonConfig>;
+}
+export interface MenuButtonData {
+    text: string;
+}
+export interface QuestData {
+    title: string;
+    description: string;
+    objectives: {
+        [key: string]: ObjectiveData;
+    };
+}
+export interface ObjectiveData {
+    description: string;
+    hidden?: boolean;
+}
+export interface ItemData {
+    name: string;
+    description: string;
+    icon: string;
+    onUse?: {
+        action: 'jump' | 'run';
+        label: string;
+    };
+    tag?: string;
+}
+export interface HudStatConfig {
+    name: string;
+    icon: string;
+    startingValue: number;
+    minValue?: number;
+    maxValue?: number;
+}
+export interface AudioConfig {
+    src: string;
+    path?: string;
+    volume?: number;
+    rate?: number;
+    html5?: boolean;
+}
+export interface MusicConfig extends AudioConfig {
+    loop?: boolean;
+}
+export interface ButtonConfig {
+    enabled: boolean;
+    background?: string;
+    text?: string;
+    position: {
+        left: number;
+        top: number;
+        width?: number;
+        height?: number;
+    };
+    anchor?: {
+        x: number;
+        y: number;
+    };
+    action: string;
+    actionType?: 'jump' | 'run';
+    tag?: string;
+}
+export interface InlineButtonConfig extends ButtonConfig {
+    id: string;
+}
+export interface SkillData {
+    name: string;
+    description: string;
+    startingLevel: number;
+    hidden?: boolean;
+    icon: string;
+}

package/dist/constants.d.ts

@@ -1,10 +1,8 @@
-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 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;

package/dist/defaultConfig.d.ts

@@ -1,2 +1,2 @@
-import { Config } from './config';
-export declare const defaultConfig: Config;
+import { Config } from './config';
+export declare const defaultConfig: Config;

package/dist/demo/demo.d.ts

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

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

@@ -1,41 +1,41 @@
-import { PropType } from 'vue';
-import { DialogChoice } from './stores/dialog-store';
-import { DialogStyle } from './types/character-types';
-import { DialogBoxParameters } from './types/dialog-box-types';
-declare const _default: import("vue").DefineComponent<{
-    options: {
-        type: PropType<DialogBoxParameters>;
-        required: true;
-    };
-    active: BooleanConstructor;
-}, unknown, {
-    playerText: string;
-    passed: boolean;
-    listener: any;
-    timeout: any;
-}, {
-    preText(): string;
-    style(): DialogStyle;
-    dialogBoxStyle(): any;
-    titleStyle(): any;
-    textStyle(): any;
-    choices(): DialogChoice[] | undefined;
-    canInteract(): boolean;
-    paused: () => boolean;
-}, {
-    clearListeners(): void;
-    chooseOption(choice: DialogChoice | number): void;
-    finishLine(): void;
-    dialogStyle(choice: DialogChoice): any;
-    dialogClass(choice: DialogChoice): "strike-anim" | undefined;
-    submitText(): 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;
+import { PropType } from 'vue';
+import { DialogChoice } from './stores/dialog-store';
+import { DialogStyle } from './types/character-types';
+import { DialogBoxParameters } from './types/dialog-box-types';
+declare const _default: import("vue").DefineComponent<{
+    options: {
+        type: PropType<DialogBoxParameters>;
+        required: true;
+    };
+    active: BooleanConstructor;
+}, unknown, {
+    playerText: string;
+    passed: boolean;
+    listener: any;
+    timeout: any;
+}, {
+    preText(): string;
+    style(): DialogStyle;
+    dialogBoxStyle(): any;
+    titleStyle(): any;
+    textStyle(): any;
+    choices(): DialogChoice[] | undefined;
+    canInteract(): boolean;
+    paused: () => boolean;
+}, {
+    clearListeners(): void;
+    chooseOption(choice: DialogChoice | number): void;
+    finishLine(): void;
+    dialogStyle(choice: DialogChoice): any;
+    dialogClass(choice: DialogChoice): "strike-anim" | undefined;
+    submitText(): 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/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/plugins.d.ts

@@ -1,38 +1,20 @@
-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 { MenuButtonState } 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: MenuButtonState;
-    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';
+export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+declare type NarratPluginObject<T> = {
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin<T>[];
+};
+declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
+declare function addCommand<T>(command: CommandPlugin<T>): void;
+export { CommandRunner };
+export { CommandPlugin, NarratPlugin, registerPlugin, addCommand, generateParser, };
+export type { NarratPluginObject };