narrat 3.2.0 → 3.2.1

package/dist/exports/plugins.d.ts

@@ -1,69 +1,69 @@
-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';
-import { CustomSetting } from '../config/settings-config';
-export 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 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 type NarratPluginObject<T> = {
-    pluginId: string;
-    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[];
-    startMenuButtons?: CustomStartMenuButton[];
-    customSettings?: Record<string, CustomSetting>;
-    save?: () => any;
-    load?: (data: any) => void;
-    reset?: () => void;
-    loadingPromises?: Promise<any>[];
-};
-/**
- * Custom buttons that get added to the start menu (where the New Game etc buttons are)
- * Action option is to provide a function to run on click
- * popupComponent option is to provide a component to display in a modal window on click (for custom pieces of UI)
- */
-export interface CustomStartMenuButton {
-    id: string;
-    text: string;
-    action?: () => void;
-    popupComponent?: {
-        name: string;
-        component: any;
-    };
-}
-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';
+import { CustomSetting } from '../config/settings-config';
+export 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 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 type NarratPluginObject<T> = {
+    pluginId: string;
+    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[];
+    startMenuButtons?: CustomStartMenuButton[];
+    customSettings?: Record<string, CustomSetting>;
+    save?: () => any;
+    load?: (data: any) => void;
+    reset?: () => void;
+    loadingPromises?: Promise<any>[];
+};
+/**
+ * Custom buttons that get added to the start menu (where the New Game etc buttons are)
+ * Action option is to provide a function to run on click
+ * popupComponent option is to provide a component to display in a modal window on click (for custom pieces of UI)
+ */
+export interface CustomStartMenuButton {
+    id: string;
+    text: string;
+    action?: () => void;
+    popupComponent?: {
+        name: string;
+        component: any;
+    };
+}
+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,17 +1,17 @@
-export { useAudio } from '../stores/audio-store';
-export { useConfig } from '../stores/config-store';
-export { useDialogStore } from '../stores/dialog-store';
-export { useHud } from '../stores/hud-stats-store';
-export { useInputs } from '../stores/inputs-store';
-export { useInventory } from '../stores/inventory-store';
-export { useMain } from '../stores/main-store';
-export { useMenu } from '../stores/menu-store';
-export { useNotifications } from '../stores/notification-store';
-export { useQuests } from '../stores/quest-log';
-export { useRenderingStore } from '../stores/rendering-store';
-export { useScreenObjects } from '../stores/screen-objects-store';
-export { useScreens } from '../stores/screens-store';
-export { useSkills } from '../stores/skills';
-export { useTooltips } from '../stores/tooltip-store';
-export { useVM } from '../stores/vm-store';
-export { useAchievements } from '../stores/achievements-store';
+export { useAudio } from '../stores/audio-store';
+export { useConfig } from '../stores/config-store';
+export { useDialogStore } from '../stores/dialog-store';
+export { useHud } from '../stores/hud-stats-store';
+export { useInputs } from '../stores/inputs-store';
+export { useInventory } from '../stores/inventory-store';
+export { useMain } from '../stores/main-store';
+export { useMenu } from '../stores/menu-store';
+export { useNotifications } from '../stores/notification-store';
+export { useQuests } from '../stores/quest-log';
+export { useRenderingStore } from '../stores/rendering-store';
+export { useScreenObjects } from '../stores/screen-objects-store';
+export { useScreens } from '../stores/screens-store';
+export { useSkills } from '../stores/skills';
+export { useTooltips } from '../stores/tooltip-store';
+export { useVM } from '../stores/vm-store';
+export { useAchievements } from '../stores/achievements-store';

package/dist/exports/utils.d.ts

@@ -1,12 +1,12 @@
-export { error, warning } from '../utils/error-handling';
-export { processText, findVariable } from '../utils/string-helpers';
-export { getFile, loadDataFile } from '../utils/ajax';
-export { getWindow } from '../utils/getWindow';
-export { InputsListener, inputEvents } from '../utils/InputsListener';
-export type { InputEvents } from '../utils/InputsListener';
-export { LogManager, logManager, logger } from '../utils/logger';
-export { timeout } from '../utils/promises';
-export { randomId } from '../utils/randomId';
-export { Vec2 } from '../utils/Vector2';
-export type { Vector2 } from '../utils/Vector2';
-export { gameloop } from '../utils/gameloop';
+export { error, warning } from '../utils/error-handling';
+export { processText, findVariable } from '../utils/string-helpers';
+export { getFile, loadDataFile } from '../utils/ajax';
+export { getWindow } from '../utils/getWindow';
+export { InputsListener, inputEvents } from '../utils/InputsListener';
+export type { InputEvents } from '../utils/InputsListener';
+export { LogManager, logManager, logger } from '../utils/logger';
+export { timeout } from '../utils/promises';
+export { randomId } from '../utils/randomId';
+export { Vec2 } from '../utils/Vector2';
+export type { Vector2 } from '../utils/Vector2';
+export { gameloop } from '../utils/gameloop';

package/dist/hmr/hmr.d.ts

@@ -1,4 +1,4 @@
-import { NarratScript } from '../types/app-types';
-import { ModuleNamespace } from 'vite/types/hot';
-export declare function handleHMR(newModule: ModuleNamespace | undefined): void;
-export declare function isNarratScript(scriptModule: any): scriptModule is NarratScript;
+import { NarratScript } from '../types/app-types';
+import { ModuleNamespace } from 'vite/types/hot';
+export declare function handleHMR(newModule: ModuleNamespace | undefined): void;
+export declare function isNarratScript(scriptModule: any): scriptModule is NarratScript;

package/dist/hooks/util-hooks.d.ts

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

package/dist/inputs/Inputs.d.ts

@@ -1,96 +1,96 @@
-import { Vector2 } from '../utils/Vector2';
-export type NarratGamepadButton = {
-    index: number;
-    state: GamepadButton;
-    previous: GamepadButton;
-};
-export type NarratGamepad = {
-    id: string;
-    gamepad: Gamepad;
-    buttons: NarratGamepadButton[];
-};
-export type ButtonEvent = (action: ButtonAction, state: ButtonActionState, previousState: ButtonActionState) => void;
-export type AnalogEvent = (action: AnalogAction, state: AnalogActionState, previousState: AnalogActionState) => void;
-export interface ButtonKeybind {
-    keyboardKey?: string;
-    gamepadButton?: number;
-}
-export interface AnalogKeybind {
-    left: string;
-    right: string;
-    up: string;
-    down: string;
-}
-export interface ButtonAction {
-    id: string;
-    type: 'button';
-    action: 'press' | 'release';
-    keybinds: ButtonKeybind[];
-}
-export interface AnalogAction {
-    id: string;
-    type: 'analog';
-    keybinds: AnalogKeybind[];
-}
-export interface ButtonActionState {
-    config: ButtonAction;
-    active: boolean;
-    justPressed: boolean;
-    justReleased: boolean;
-}
-export interface AnalogDirectionState {
-    left: number;
-    right: number;
-    up: number;
-    down: number;
-}
-export interface AnalogActionState {
-    config: AnalogAction;
-    value: Vector2;
-    fullState: AnalogDirectionState;
-}
-export type Action = ButtonAction | AnalogAction;
-export type ActionState = ButtonActionState | AnalogActionState;
-export type ButtonActionStatus = {
-    state: ButtonActionState;
-    previous: ButtonActionState;
-};
-export type AnalogActionStatus = {
-    state: AnalogActionState;
-    previous: AnalogActionState;
-};
-export type ActionStatus = ButtonActionStatus | AnalogActionStatus;
-export declare class Inputs {
-    gameActions: {
-        [key: string]: Action;
-    };
-    keyboardState: {
-        [key: string]: {
-            current: boolean;
-            previous: boolean;
-        };
-    };
-    actions: {
-        [key: string]: ActionStatus;
-    };
-    gamepad: NarratGamepad | null;
-    startListening(): void;
-    updateGamepad(): void;
-    setupNarratGamepad(gamepad: Gamepad): NarratGamepad;
-    updateAllNarratButtons(gamepad: Gamepad, narratGamepad: NarratGamepad): void;
-    getNarratButtonFromGamepad(previous: GamepadButton, gamepadButton: GamepadButton, index: number): NarratGamepadButton;
-    addAction(action: Action): void;
-    getAnalog(actionId: string): AnalogActionState;
-    getButton(actionId: string): ButtonActionState;
-    getKeyboardState(key: string): {
-        current: boolean;
-        previous: boolean;
-    };
-    getGamepadState(key: number): {
-        current: GamepadButton;
-        previous: GamepadButton;
-    } | null;
-    debugGamepad(): void;
-    update(): void;
-}
-export declare const inputs: Inputs;
+import { Vector2 } from '../utils/Vector2';
+export type NarratGamepadButton = {
+    index: number;
+    state: GamepadButton;
+    previous: GamepadButton;
+};
+export type NarratGamepad = {
+    id: string;
+    gamepad: Gamepad;
+    buttons: NarratGamepadButton[];
+};
+export type ButtonEvent = (action: ButtonAction, state: ButtonActionState, previousState: ButtonActionState) => void;
+export type AnalogEvent = (action: AnalogAction, state: AnalogActionState, previousState: AnalogActionState) => void;
+export interface ButtonKeybind {
+    keyboardKey?: string;
+    gamepadButton?: number;
+}
+export interface AnalogKeybind {
+    left: string;
+    right: string;
+    up: string;
+    down: string;
+}
+export interface ButtonAction {
+    id: string;
+    type: 'button';
+    action: 'press' | 'release';
+    keybinds: ButtonKeybind[];
+}
+export interface AnalogAction {
+    id: string;
+    type: 'analog';
+    keybinds: AnalogKeybind[];
+}
+export interface ButtonActionState {
+    config: ButtonAction;
+    active: boolean;
+    justPressed: boolean;
+    justReleased: boolean;
+}
+export interface AnalogDirectionState {
+    left: number;
+    right: number;
+    up: number;
+    down: number;
+}
+export interface AnalogActionState {
+    config: AnalogAction;
+    value: Vector2;
+    fullState: AnalogDirectionState;
+}
+export type Action = ButtonAction | AnalogAction;
+export type ActionState = ButtonActionState | AnalogActionState;
+export type ButtonActionStatus = {
+    state: ButtonActionState;
+    previous: ButtonActionState;
+};
+export type AnalogActionStatus = {
+    state: AnalogActionState;
+    previous: AnalogActionState;
+};
+export type ActionStatus = ButtonActionStatus | AnalogActionStatus;
+export declare class Inputs {
+    gameActions: {
+        [key: string]: Action;
+    };
+    keyboardState: {
+        [key: string]: {
+            current: boolean;
+            previous: boolean;
+        };
+    };
+    actions: {
+        [key: string]: ActionStatus;
+    };
+    gamepad: NarratGamepad | null;
+    startListening(): void;
+    updateGamepad(): void;
+    setupNarratGamepad(gamepad: Gamepad): NarratGamepad;
+    updateAllNarratButtons(gamepad: Gamepad, narratGamepad: NarratGamepad): void;
+    getNarratButtonFromGamepad(previous: GamepadButton, gamepadButton: GamepadButton, index: number): NarratGamepadButton;
+    addAction(action: Action): void;
+    getAnalog(actionId: string): AnalogActionState;
+    getButton(actionId: string): ButtonActionState;
+    getKeyboardState(key: string): {
+        current: boolean;
+        previous: boolean;
+    };
+    getGamepadState(key: number): {
+        current: GamepadButton;
+        previous: GamepadButton;
+    } | null;
+    debugGamepad(): void;
+    update(): void;
+}
+export declare const inputs: Inputs;

package/dist/inputs/useNavigation.d.ts

@@ -1,30 +1,30 @@
-import { InputListener } from '../stores/inputs-store';
-import { Ref } from 'vue';
-export type GridNavigationOptions = {
-    mode: 'grid';
-    columns: number;
-};
-export type ListNavigationOptions = {
-    mode: 'list';
-};
-export type NavigationOptions = {
-    mode: 'grid' | 'list';
-    container: Ref<HTMLElement | null>;
-    listener: InputListener;
-    loopForbidden?: boolean;
-    onSelected?: (index: number) => void;
-} & (GridNavigationOptions | ListNavigationOptions);
-export declare function useNavigation(options: NavigationOptions): {
-    selectedIndex: Ref<number>;
-    selectedElement: import("vue").ComputedRef<Element | null>;
-    currentColumn: import("vue").ComputedRef<number>;
-    buttonDown: () => void;
-    buttonUp: () => void;
-    buttonLeft: () => void;
-    buttonRight: () => void;
-    selectUp: () => void;
-    selectDown: () => void;
-    selectPrevious: () => void;
-    selectNext: () => void;
-    select: (index: number) => void;
-};
+import { InputListener } from '../stores/inputs-store';
+import { Ref } from 'vue';
+export type GridNavigationOptions = {
+    mode: 'grid';
+    columns: number;
+};
+export type ListNavigationOptions = {
+    mode: 'list';
+};
+export type NavigationOptions = {
+    mode: 'grid' | 'list';
+    container: Ref<HTMLElement | null>;
+    listener: InputListener;
+    loopForbidden?: boolean;
+    onSelected?: (index: number) => void;
+} & (GridNavigationOptions | ListNavigationOptions);
+export declare function useNavigation(options: NavigationOptions): {
+    selectedIndex: Ref<number>;
+    selectedElement: import("vue").ComputedRef<Element | null>;
+    currentColumn: import("vue").ComputedRef<number>;
+    buttonDown: () => void;
+    buttonUp: () => void;
+    buttonLeft: () => void;
+    buttonRight: () => void;
+    selectUp: () => void;
+    selectDown: () => void;
+    selectPrevious: () => void;
+    selectNext: () => void;
+    select: (index: number) => void;
+};

package/dist/lib.d.ts

@@ -1,22 +1,22 @@
-import { App } from 'vue';
-import type { NarratScript } from './types/app-types';
-import 'es6-promise/auto';
-export * from './main';
-export type Narrat = {
-    app: App;
-};
-declare global {
-    export interface Window {
-        narrat: Narrat;
-    }
-}
-export * from './exports/plugins';
-export * from './exports/display';
-export * from './exports/config';
-export * from './exports/events';
-export * from './exports/inputs';
-export * from './exports/stores';
-export * from './exports/others';
-export * from './exports/components';
-export * from './exports/utils';
-export { NarratScript };
+import { App } from 'vue';
+import type { NarratScript } from './types/app-types';
+import 'es6-promise/auto';
+export * from './main';
+export type Narrat = {
+    app: App;
+};
+declare global {
+    export interface Window {
+        narrat: Narrat;
+    }
+}
+export * from './exports/plugins';
+export * from './exports/display';
+export * from './exports/config';
+export * from './exports/events';
+export * from './exports/inputs';
+export * from './exports/stores';
+export * from './exports/others';
+export * from './exports/components';
+export * from './exports/utils';
+export { NarratScript };

package/dist/main.d.ts

@@ -1,9 +1,9 @@
-import 'es6-promise/auto';
-import 'virtual:windi.css';
-import 'virtual:windi-devtools';
-import './css/main.css';
-import { AppOptionsInput } from './types/app-types';
-import { ModuleNamespace } from 'vite/types/hot';
-export type HMRCallback = (mod: ModuleNamespace | undefined) => void;
-export declare function startApp(optionsInput: AppOptionsInput): Promise<any>;
-export declare function registerComponent(name: string, component: any): void;
+import 'es6-promise/auto';
+import 'virtual:windi.css';
+import 'virtual:windi-devtools';
+import './css/main.css';
+import { AppOptionsInput } from './types/app-types';
+import { ModuleNamespace } from 'vite/types/hot';
+export type HMRCallback = (mod: ModuleNamespace | undefined) => void;
+export declare function startApp(optionsInput: AppOptionsInput): Promise<any>;
+export declare function registerComponent(name: string, component: any): void;

package/dist/menu-buttons/menu-buttons.d.ts

@@ -1,7 +1,7 @@
-import { MenuState, MenuTabState } from '../stores/menu-store';
-export declare function registerDefaultMenuButtons(app: any): void;
-export declare function registerMenuButton(id: string, config: MenuState, components: {
-    [key: string]: any;
-}): void;
-export declare function registerMenuTab(id: string, config: MenuTabState, component: any): void;
-export declare function addMenuButtonsFromPlugins(): void;
+import { MenuState, MenuTabState } from '../stores/menu-store';
+export declare function registerDefaultMenuButtons(app: any): void;
+export declare function registerMenuButton(id: string, config: MenuState, components: {
+    [key: string]: any;
+}): void;
+export declare function registerMenuTab(id: string, config: MenuTabState, component: any): void;
+export declare function addMenuButtonsFromPlugins(): void;