narrat 1.3.0 → 2.0.0-rc1

package/lib/app.vue.d.ts

@@ -1,7 +1,7 @@
 import { PropType } from 'vue';
 import { DialogBoxParameters } from './types/dialog-box-types';
 import { GameConfig } from './types/app-types';
-import { AppOptions } from '.';
+import { AppOptions } from './config';
 import { Parser } from './types/parser';
 import { DialogKey } from './stores/dialog-store';
 declare const _default: import("vue").DefineComponent<{
@@ -24,49 +24,17 @@ declare const _default: import("vue").DefineComponent<{
         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;
+            command: {
+                commandType: string;
+                operator: string;
+                args: (Parser.Primitive | {
+                    code: string;
+                    command: any;
+                    fileName: string;
+                    line: number;
+                })[];
+                options: Parser.DefaultArg;
+                staticOptions?: unknown;
             };
             fileName: string;
             line: number;
@@ -85,7 +53,6 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     dialogLength(): number;
     lastDialog(): DialogKey | undefined;
-    command(): Parser.Command;
     picture(): string | undefined;
     backgroundStyle(): any;
     layoutWidth(): number;
@@ -106,7 +73,7 @@ declare const _default: import("vue").DefineComponent<{
     gameStyle(): any;
     screenRatio(): number;
     dialogContainerStyle(): any;
-    currentLine: () => Parser.Command;
+    currentLine: () => Parser.ParsedExpression<Parser.DefaultArg, undefined>;
     screenWidth: () => number;
     screenHeight: () => number;
     canvasWidth: () => number;

package/lib/components/MainMenu.vue.d.ts

@@ -1,18 +1,15 @@
-declare const _default: import("vue").DefineComponent<Readonly<import("vue").ComponentPropsOptions<{
-    [x: string]: unknown;
-}>>, unknown, void, {
+declare const _default: import("vue").DefineComponent<{
+    close: FunctionConstructor;
+}, unknown, void, {
     playTime: () => {
         start: number;
         previousPlaytime: number;
     };
 }, {
     quit(): void;
-    close(): void;
     mainMenu(): void;
     getPlayTimeString(): string;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, readonly string[] | Readonly<import("vue").ExtractPropTypes<Readonly<import("vue").ComponentObjectPropsOptions<{
-    [x: string]: unknown;
-}>>>>, {
-    [x: number]: string;
-} | {}>;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    close: FunctionConstructor;
+}>>, {}>;
 export default _default;

package/lib/components/Skills.vue.d.ts

@@ -1,7 +1,7 @@
 import { SkillData } from '@/config';
 import { SkillsState } from '@/stores/skills';
 declare const _default: import("vue").DefineComponent<{
-    close: any;
+    close: FunctionConstructor;
 }, {
     skills: import("vue").ComputedRef<SkillsState>;
 }, {
@@ -21,8 +21,6 @@ declare const _default: import("vue").DefineComponent<{
         width: string;
     };
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    close: any;
-}>>, {
-    close: any;
-}>;
+    close: FunctionConstructor;
+}>>, {}>;
 export default _default;

package/lib/components/debug/debug-menu.vue.d.ts

@@ -40,7 +40,7 @@ declare const _default: import("vue").DefineComponent<{}, {
     onSearchInput(): void;
     save(): void;
     wordCount(): void;
-    countWordsInScriptLine(scriptLine: Parser.Command): number;
+    countWordsInScriptLine(scriptLine: Parser.ParsedExpression): number;
     countWordsInString(string: string): number;
     countWordsInScriptBranch(branch: Parser.Branch): number;
     getPlayTimeString(): string;

package/lib/components/inventory.vue.d.ts

@@ -1,11 +1,12 @@
 import { ItemData } from '@/config';
 import { ItemState } from '@/stores/inventory-store';
 declare const _default: import("vue").DefineComponent<{
-    close: any;
+    close: FunctionConstructor;
 }, {
     items: import("vue").ComputedRef<{
         [key: string]: ItemState;
     }>;
+    currentlyChoosing: import("vue").ComputedRef<import("@/stores/dialog-store").DialogChoice[]>;
 }, {
     chosenId: string | false;
 }, {
@@ -13,6 +14,7 @@ declare const _default: import("vue").DefineComponent<{
         [key: string]: ItemState;
     };
     chosenItem(): null | ItemState;
+    canUseChosenItem(): boolean;
     chosenItemConf(): null | ItemData;
     itemConf(): {
         [key: string]: ItemData;
@@ -20,11 +22,12 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     getItemStyle(item: string): any;
     getItemName(item: string): string;
+    getItemConf(item: string): ItemData;
     clickItem(item: string): void;
     closeItem(): void;
+    useItem(): void;
+    canUseItem(item: ItemState): boolean;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    close: any;
-}>>, {
-    close: any;
-}>;
+    close: FunctionConstructor;
+}>>, {}>;
 export default _default;

package/lib/components/quests.vue.d.ts

@@ -1,6 +1,6 @@
 import { QuestState, ObjectiveState } from '../stores/quest-log';
 declare const _default: import("vue").DefineComponent<{
-    close: any;
+    close: FunctionConstructor;
 }, {
     quests: import("vue").ComputedRef<{
         [key: string]: QuestState;
@@ -18,8 +18,6 @@ declare const _default: import("vue").DefineComponent<{
         [key: string]: ObjectiveState;
     };
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    close: any;
-}>>, {
-    close: any;
-}>;
+    close: FunctionConstructor;
+}>>, {}>;
 export default _default;

package/lib/config.d.ts

@@ -4,6 +4,10 @@ export declare function getSkillConfig(id: string): SkillData;
 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 {
+    logging: boolean;
+    debug: boolean;
+}
 export interface Config {
     gameTitle: string;
     images: {
@@ -71,6 +75,11 @@ export interface Config {
     items: {
         [key: string]: ItemData;
     };
+    interactionTags: {
+        [key: string]: {
+            onlyInteractOutsideOfScripts: boolean;
+        };
+    };
     quests: {
         [key: string]: QuestData;
     };
@@ -90,6 +99,11 @@ export interface ItemData {
     name: string;
     description: string;
     icon: string;
+    onUse?: {
+        action: 'jump' | 'run_label';
+        label: string;
+    };
+    tag?: string;
 }
 export interface HudStatConfig {
     name: string;

package/lib/exports/plugins.d.ts

@@ -2,7 +2,7 @@ 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 = {
+declare type NarratPluginObject<T> = {
     onPageLoaded?: NarratLifecycleHook;
     onNarratSetup?: NarratLifecycleHook;
     onAppMounted?: NarratLifecycleHook;
@@ -11,9 +11,9 @@ declare type NarratPluginObject = {
     onGameStart?: NarratLifecycleHook;
     onGameMounted?: NarratLifecycleHook;
     onGameUnmounted?: NarratLifecycleHook;
-    customCommands?: CommandPlugin[];
+    customCommands?: CommandPlugin<T>[];
 };
-declare function registerPlugin(plugin: NarratPluginObject): void;
-declare function addCommand(command: CommandPlugin): void;
+declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
+declare function addCommand<T>(command: CommandPlugin<T>): void;
 export { CommandRunner };
 export { CommandPlugin, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/lib/index.d.ts

@@ -2,10 +2,7 @@ import 'es6-promise/auto';
 import './/sass/main.css';
 import { App } from 'vue';
 import { GameConfig } from './types/app-types';
-export interface AppOptions {
-    logging: boolean;
-    debug: boolean;
-}
+import { AppOptions } from './config';
 export declare function startApp(config: GameConfig, options: AppOptions): Promise<void>;
 export declare type Narrat = {
     app: App;