narrat 0.7.0 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Narrat changelog
 
+## 0.8.1
+
+- Fixed a bug in accessing values inside conditions caused by changed in 0.7.2
+
+## 0.8.0
+
+- Changed the `set` method to access things without caps (`data`, `skills`, `buttons` instead of `DATA`, `SKILLS`, `BUTTONS`) for consistency.
+- Changed string interpolation to have more accessible objects, now values in `data` need to be accessed with `%{data.something}` instead of just `%{something}`
+- Now possible to access skill levels in string interpolation with `%{skills.someSkill.level}`
+- Improvements to how skill checks are printed to be less awkward
+
+## 0.7.1
+
+- Added `stop` and `pause` functions which work similarly to play for stopping or pausing audio.
+
 ## 0.6.5
 
 - Audio and music options from the config now get passed to howler

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-// Version: 0.7.0 - April 25, 2022 17:09:02
+// Version: 0.8.1 - April 26, 2022 13:28:12
 import 'es6-promise/auto';
 import { ref, reactive, readonly, defineComponent, openBlock, createElementBlock, normalizeStyle, createElementVNode, createCommentVNode, Fragment, renderList, createBlock, Transition, withCtx, renderSlot, createTextVNode, resolveComponent, toDisplayString, createVNode, TransitionGroup, createApp } from 'vue';
 import { createLogger, createStore } from 'vuex';
@@ -4079,16 +4079,20 @@ function addDataHelper(sourceObj, path, value) {
 }
 function getModifiableData(state) {
     return {
-        DATA: state.machine.data,
-        SKILLS: state.skills,
-        BUTTONS: state.buttons,
+        data: state.machine.data,
+        skills: state.skills,
+        buttons: state.buttons,
     };
 }
 
 function processText(store, text) {
     return text.replace(/%{[^}]*}/g, (match) => {
         const key = match.substr(2, match.length - 3);
-        const [obj, newKey] = findDataHelper(store.state.machine.data, key);
+        const searchableState = {
+            data: store.state.machine.data,
+            skills: store.state.skills,
+        };
+        const [obj, newKey] = findDataHelper(searchableState, key);
         return obj[newKey];
     });
 }
@@ -4197,8 +4201,12 @@ async function loadAudio(key, config) {
 function changeMusic(ctx, newMusic) {
     if (ctx.state.audio.currentMusic) {
         const oldMusic = getAudio(ctx.state.audio.currentMusic);
+        const newMusicHowl = getAudio(newMusic);
         if (oldMusic) {
-            oldMusic.stop();
+            if (oldMusic !== newMusicHowl) {
+                // Stop the previous music if it's a different one
+                oldMusic.stop();
+            }
         }
     }
     ctx.commit('setMusic', newMusic);
@@ -4217,6 +4225,24 @@ function playAudio(commit, key) {
 }
 function getAudio(key) {
     return audio[key];
+}
+function stopAudio(commit, key) {
+    const sound = getAudio(key);
+    if (sound) {
+        sound.stop();
+    }
+    else {
+        error(commit, `Sound effect ${key} not found!`);
+    }
+}
+function pauseAudio(commit, key) {
+    const sound = getAudio(key);
+    if (sound) {
+        sound.pause();
+    }
+    else {
+        error(commit, `Sound effect ${key} not found!`);
+    }
 }
 
 function debounce(func, waitMilliseconds = 50, options = {}) {
@@ -4694,6 +4720,8 @@ function processSkillCheck(ctx, skillcheck) {
         skill: skillcheck.skill,
         value: skillcheck.value,
         id: skillcheck.id,
+        success: skillcheck.success.text,
+        failure: skillcheck.failure.text,
     });
 }
 function runSkillCheck(ctx, params) {
@@ -4712,11 +4740,11 @@ function runSkillCheck(ctx, params) {
     }
     if (success) {
         ctx.commit('passSkillCheck', params.id);
-        writeText(ctx, `[${skill.name} - Success]`);
+        writeText(ctx, `[${skill.name} - Success] ${params.success || ''}`);
         return true;
     }
     ctx.commit('failSkillCheck', params.id);
-    writeText(ctx, `[${skill.name} - Failure]`);
+    writeText(ctx, `[${skill.name} - Failure] ${params.failure || ''}`);
     return false;
 }
 function runConditionCommand(ctx, command) {
@@ -4747,10 +4775,10 @@ function runCondition(ctx, condition) {
 function conditionFunction(ctx, condition) {
     const { state } = ctx;
     const context = {
-        DATA: state.machine.data,
-        SKILLS: state.skills,
-        SKILLCHECKS: state.skillChecks,
-        STATS: state.hudStats,
+        data: state.machine.data,
+        skills: state.skills,
+        skillChecks: state.skillChecks,
+        stats: state.hudStats,
         roll: (checkId, skill, value) => {
             const skillCheckState = getSkillCheckState(ctx, checkId);
             if (skillCheckState) {
@@ -4850,12 +4878,36 @@ async function runCommand(context, cmd, choices) {
                 });
                 return dispatch('nextLine');
             case 'play':
-                const options = cmd.options;
-                if (options.mode === 'music') {
-                    changeMusic(context, options.audio);
+                const playOptions = cmd.options;
+                if (playOptions.mode === 'music') {
+                    changeMusic(context, playOptions.audio);
+                }
+                else {
+                    playAudio(context.commit, playOptions.audio);
+                }
+                return dispatch('nextLine');
+            case 'stop':
+                const stopOptions = cmd.options;
+                if (stopOptions.mode === 'music') {
+                    stopAudio(commit, context.state.audio.currentMusic);
+                }
+                else if (stopOptions.mode === 'sound' && stopOptions.audio) {
+                    stopAudio(commit, stopOptions.audio);
                 }
                 else {
-                    playAudio(context.commit, options.audio);
+                    error(commit, `stop option needs to either be in music mode, or if stopping a sound needs to have the sound name supplied as second argument.`);
+                }
+                return dispatch('nextLine');
+            case 'pause':
+                const pauseOptions = cmd.options;
+                if (pauseOptions.mode === 'music') {
+                    pauseAudio(commit, context.state.audio.currentMusic);
+                }
+                else if (stopOptions.mode === 'sound' && stopOptions.audio) {
+                    pauseAudio(commit, stopOptions.audio);
+                }
+                else {
+                    error(commit, `pause first option needs to either be in music mode, or if stopping a sound needs to have the sound name supplied as second argument.`);
                 }
                 return dispatch('nextLine');
             case 'wait':
@@ -4907,6 +4959,7 @@ async function runCommand(context, cmd, choices) {
     }
     catch (err) {
         console.log(state.machine.stack[state.machine.stack.length - 1].label);
+        console.error(err);
         error(commit, `Narrat script runtime error at  <span class="error-filename">${cmd.fileName}:${cmd.line + 1}</span>
       <b>${err}</b>
       Script: ${cmd.code}
@@ -4933,18 +4986,21 @@ async function playerAnswered(context, choiceIndex) {
                     const result = processSkillCheck(context, skillcheck);
                     const winner = result ? skillcheck.success : skillcheck.failure;
                     newBranch = winner.branch;
-                    playerText = `[${result ? 'SUCCESS' : 'FAILURE'}] – ${winner.text}`;
+                    playerText = undefined;
                 }
             }
             else {
                 newBranch = choice.branch;
             }
-            const dialog = {
-                speaker: 'player',
-                text: playerText,
-                interactive: true,
-            };
-            commit('addDialog', { dialog });
+            if (playerText) {
+                // If the choice involves printing a player dialog, show it
+                const dialog = {
+                    speaker: 'player',
+                    text: playerText,
+                    interactive: false,
+                };
+                commit('addDialog', { dialog });
+            }
             if (newBranch) {
                 const newStack = {
                     currentIndex: 0,
@@ -5022,9 +5078,10 @@ async function textCommand(commit, dialog) {
         dialog,
     });
 }
-async function nextLine({ state, getters, dispatch, commit, }) {
+async function nextLine(ctx) {
+    const { state, getters, dispatch, commit } = ctx;
     if (state.machine.stack.length === 0) {
-        finishGame(commit);
+        finishGame(ctx);
         return;
     }
     const machineHead = getters.machineHead;
@@ -5037,19 +5094,21 @@ async function nextLine({ state, getters, dispatch, commit, }) {
         return dispatch('nextLine');
     }
     if (state.machine.stack.length === 0) {
-        finishGame(commit);
+        finishGame(ctx);
     }
     else {
         return dispatch('runLine');
     }
 }
-function finishGame(commit) {
-    commit('addDialog', {
-        dialog: {
-            speaker: 'game',
-            text: 'You can interact with the screen on the left',
-        },
-    });
+function finishGame({ commit, state }) {
+    if (state.options.debug) {
+        commit('addDialog', {
+            dialog: {
+                speaker: 'game',
+                text: '[DEBUG] Game Script is finished. This is the end of the game flow. This message only appears in debug mode.',
+            },
+        });
+    }
 }
 
 function jump(ctx) {
@@ -5151,6 +5210,24 @@ function play(ctx) {
     };
     ctx.currentLine++;
 }
+function stop(ctx) {
+    const { command } = ctx;
+    command.commandType = 'stop';
+    command.options = {
+        mode: command.args[0],
+        audio: command.args[1],
+    };
+    ctx.currentLine++;
+}
+function pause(ctx) {
+    const { command } = ctx;
+    command.commandType = 'pause';
+    command.options = {
+        mode: command.args[0],
+        audio: command.args[1],
+    };
+    ctx.currentLine++;
+}
 function wait(ctx) {
     const { command } = ctx;
     command.commandType = 'wait';
@@ -5182,6 +5259,8 @@ const parserFunctions = {
     set_button: setButton,
     clear_dialog: clearDialog,
     play,
+    stop,
+    pause,
     wait,
     text,
     add_level,
@@ -5478,6 +5557,7 @@ function setupStore(options) {
             },
             notifications: {},
             hudStats: {},
+            options,
         },
         getters: {
             machineHead(state) {
@@ -5732,7 +5812,7 @@ async function startApp(config, options) {
         mousePos.x = e.clientX;
         mousePos.y = e.clientY;
     });
-    console.log('%c Narrat game engine – 0.7.0 - April 25, 2022 17:09:02', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.8.1 - April 26, 2022 13:28:12', 'background: #222; color: #bada55');
     const storeSetup = setupStore(options);
     store$1 = storeSetup.store;
     app = createApp(script$8, {

package/lib/index.js

@@ -1,4 +1,4 @@
-// Version: 0.7.0 - April 25, 2022 17:09:02
+// Version: 0.8.1 - April 26, 2022 13:28:12
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -4083,16 +4083,20 @@ function addDataHelper(sourceObj, path, value) {
 }
 function getModifiableData(state) {
     return {
-        DATA: state.machine.data,
-        SKILLS: state.skills,
-        BUTTONS: state.buttons,
+        data: state.machine.data,
+        skills: state.skills,
+        buttons: state.buttons,
     };
 }
 
 function processText(store, text) {
     return text.replace(/%{[^}]*}/g, (match) => {
         const key = match.substr(2, match.length - 3);
-        const [obj, newKey] = findDataHelper(store.state.machine.data, key);
+        const searchableState = {
+            data: store.state.machine.data,
+            skills: store.state.skills,
+        };
+        const [obj, newKey] = findDataHelper(searchableState, key);
         return obj[newKey];
     });
 }
@@ -4201,8 +4205,12 @@ async function loadAudio(key, config) {
 function changeMusic(ctx, newMusic) {
     if (ctx.state.audio.currentMusic) {
         const oldMusic = getAudio(ctx.state.audio.currentMusic);
+        const newMusicHowl = getAudio(newMusic);
         if (oldMusic) {
-            oldMusic.stop();
+            if (oldMusic !== newMusicHowl) {
+                // Stop the previous music if it's a different one
+                oldMusic.stop();
+            }
         }
     }
     ctx.commit('setMusic', newMusic);
@@ -4221,6 +4229,24 @@ function playAudio(commit, key) {
 }
 function getAudio(key) {
     return audio[key];
+}
+function stopAudio(commit, key) {
+    const sound = getAudio(key);
+    if (sound) {
+        sound.stop();
+    }
+    else {
+        error(commit, `Sound effect ${key} not found!`);
+    }
+}
+function pauseAudio(commit, key) {
+    const sound = getAudio(key);
+    if (sound) {
+        sound.pause();
+    }
+    else {
+        error(commit, `Sound effect ${key} not found!`);
+    }
 }
 
 function debounce(func, waitMilliseconds = 50, options = {}) {
@@ -4698,6 +4724,8 @@ function processSkillCheck(ctx, skillcheck) {
         skill: skillcheck.skill,
         value: skillcheck.value,
         id: skillcheck.id,
+        success: skillcheck.success.text,
+        failure: skillcheck.failure.text,
     });
 }
 function runSkillCheck(ctx, params) {
@@ -4716,11 +4744,11 @@ function runSkillCheck(ctx, params) {
     }
     if (success) {
         ctx.commit('passSkillCheck', params.id);
-        writeText(ctx, `[${skill.name} - Success]`);
+        writeText(ctx, `[${skill.name} - Success] ${params.success || ''}`);
         return true;
     }
     ctx.commit('failSkillCheck', params.id);
-    writeText(ctx, `[${skill.name} - Failure]`);
+    writeText(ctx, `[${skill.name} - Failure] ${params.failure || ''}`);
     return false;
 }
 function runConditionCommand(ctx, command) {
@@ -4751,10 +4779,10 @@ function runCondition(ctx, condition) {
 function conditionFunction(ctx, condition) {
     const { state } = ctx;
     const context = {
-        DATA: state.machine.data,
-        SKILLS: state.skills,
-        SKILLCHECKS: state.skillChecks,
-        STATS: state.hudStats,
+        data: state.machine.data,
+        skills: state.skills,
+        skillChecks: state.skillChecks,
+        stats: state.hudStats,
         roll: (checkId, skill, value) => {
             const skillCheckState = getSkillCheckState(ctx, checkId);
             if (skillCheckState) {
@@ -4854,12 +4882,36 @@ async function runCommand(context, cmd, choices) {
                 });
                 return dispatch('nextLine');
             case 'play':
-                const options = cmd.options;
-                if (options.mode === 'music') {
-                    changeMusic(context, options.audio);
+                const playOptions = cmd.options;
+                if (playOptions.mode === 'music') {
+                    changeMusic(context, playOptions.audio);
+                }
+                else {
+                    playAudio(context.commit, playOptions.audio);
+                }
+                return dispatch('nextLine');
+            case 'stop':
+                const stopOptions = cmd.options;
+                if (stopOptions.mode === 'music') {
+                    stopAudio(commit, context.state.audio.currentMusic);
+                }
+                else if (stopOptions.mode === 'sound' && stopOptions.audio) {
+                    stopAudio(commit, stopOptions.audio);
                 }
                 else {
-                    playAudio(context.commit, options.audio);
+                    error(commit, `stop option needs to either be in music mode, or if stopping a sound needs to have the sound name supplied as second argument.`);
+                }
+                return dispatch('nextLine');
+            case 'pause':
+                const pauseOptions = cmd.options;
+                if (pauseOptions.mode === 'music') {
+                    pauseAudio(commit, context.state.audio.currentMusic);
+                }
+                else if (stopOptions.mode === 'sound' && stopOptions.audio) {
+                    pauseAudio(commit, stopOptions.audio);
+                }
+                else {
+                    error(commit, `pause first option needs to either be in music mode, or if stopping a sound needs to have the sound name supplied as second argument.`);
                 }
                 return dispatch('nextLine');
             case 'wait':
@@ -4911,6 +4963,7 @@ async function runCommand(context, cmd, choices) {
     }
     catch (err) {
         console.log(state.machine.stack[state.machine.stack.length - 1].label);
+        console.error(err);
         error(commit, `Narrat script runtime error at  <span class="error-filename">${cmd.fileName}:${cmd.line + 1}</span>
       <b>${err}</b>
       Script: ${cmd.code}
@@ -4937,18 +4990,21 @@ async function playerAnswered(context, choiceIndex) {
                     const result = processSkillCheck(context, skillcheck);
                     const winner = result ? skillcheck.success : skillcheck.failure;
                     newBranch = winner.branch;
-                    playerText = `[${result ? 'SUCCESS' : 'FAILURE'}] – ${winner.text}`;
+                    playerText = undefined;
                 }
             }
             else {
                 newBranch = choice.branch;
             }
-            const dialog = {
-                speaker: 'player',
-                text: playerText,
-                interactive: true,
-            };
-            commit('addDialog', { dialog });
+            if (playerText) {
+                // If the choice involves printing a player dialog, show it
+                const dialog = {
+                    speaker: 'player',
+                    text: playerText,
+                    interactive: false,
+                };
+                commit('addDialog', { dialog });
+            }
             if (newBranch) {
                 const newStack = {
                     currentIndex: 0,
@@ -5026,9 +5082,10 @@ async function textCommand(commit, dialog) {
         dialog,
     });
 }
-async function nextLine({ state, getters, dispatch, commit, }) {
+async function nextLine(ctx) {
+    const { state, getters, dispatch, commit } = ctx;
     if (state.machine.stack.length === 0) {
-        finishGame(commit);
+        finishGame(ctx);
         return;
     }
     const machineHead = getters.machineHead;
@@ -5041,19 +5098,21 @@ async function nextLine({ state, getters, dispatch, commit, }) {
         return dispatch('nextLine');
     }
     if (state.machine.stack.length === 0) {
-        finishGame(commit);
+        finishGame(ctx);
     }
     else {
         return dispatch('runLine');
     }
 }
-function finishGame(commit) {
-    commit('addDialog', {
-        dialog: {
-            speaker: 'game',
-            text: 'You can interact with the screen on the left',
-        },
-    });
+function finishGame({ commit, state }) {
+    if (state.options.debug) {
+        commit('addDialog', {
+            dialog: {
+                speaker: 'game',
+                text: '[DEBUG] Game Script is finished. This is the end of the game flow. This message only appears in debug mode.',
+            },
+        });
+    }
 }
 
 function jump(ctx) {
@@ -5155,6 +5214,24 @@ function play(ctx) {
     };
     ctx.currentLine++;
 }
+function stop(ctx) {
+    const { command } = ctx;
+    command.commandType = 'stop';
+    command.options = {
+        mode: command.args[0],
+        audio: command.args[1],
+    };
+    ctx.currentLine++;
+}
+function pause(ctx) {
+    const { command } = ctx;
+    command.commandType = 'pause';
+    command.options = {
+        mode: command.args[0],
+        audio: command.args[1],
+    };
+    ctx.currentLine++;
+}
 function wait(ctx) {
     const { command } = ctx;
     command.commandType = 'wait';
@@ -5186,6 +5263,8 @@ const parserFunctions = {
     set_button: setButton,
     clear_dialog: clearDialog,
     play,
+    stop,
+    pause,
     wait,
     text,
     add_level,
@@ -5482,6 +5561,7 @@ function setupStore(options) {
             },
             notifications: {},
             hudStats: {},
+            options,
         },
         getters: {
             machineHead(state) {
@@ -5736,7 +5816,7 @@ async function startApp(config, options) {
         mousePos.x = e.clientX;
         mousePos.y = e.clientY;
     });
-    console.log('%c Narrat game engine – 0.7.0 - April 25, 2022 17:09:02', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.8.1 - April 26, 2022 13:28:12', 'background: #222; color: #bada55');
     const storeSetup = setupStore(options);
     store$1 = storeSetup.store;
     app = vue.createApp(script$8, {

package/lib/renpy/renpy-helpers.d.ts

@@ -5,6 +5,8 @@ export interface SkillCheckParams {
     skill: string;
     value: number;
     id: string;
+    success?: string;
+    failure?: string;
 }
 export declare function runSkillCheck(ctx: ActionContext<State, State>, params: SkillCheckParams): boolean;
 export declare function runConditionCommand(ctx: ActionContext<State, State>, command: Parser.Command): Parser.Branch | undefined;

package/lib/utils/audio-loader.d.ts

@@ -10,3 +10,5 @@ export declare function loadAudio(key: string, config: AudioConfig | MusicConfig
 export declare function changeMusic(ctx: ActionContext<State, State>, newMusic: string): void;
 export declare function playAudio(commit: Commit, key: string): void;
 export declare function getAudio(key: string): Howl | undefined;
+export declare function stopAudio(commit: Commit, key: string): void;
+export declare function pauseAudio(commit: Commit, key: string): void;

package/lib/utils/data-helpers.d.ts

@@ -3,7 +3,7 @@ export declare function findDataHelper<T>(sourceObj: any, path: string): [T, str
 export declare function setDataHelper<T>(sourceObj: any, path: string, value: T): void;
 export declare function addDataHelper<T>(sourceObj: any, path: string, value: T): void;
 export declare function getModifiableData(state: State): {
-    DATA: import("../types/vuex").DataState;
-    SKILLS: import("../types/vuex").SkillsState;
-    BUTTONS: import("vue").ButtonsState;
+    data: import("../types/vuex").DataState;
+    skills: import("../types/vuex").SkillsState;
+    buttons: import("vue").ButtonsState;
 };

package/lib/vm/renpy-vm.d.ts

@@ -6,5 +6,5 @@ export declare function runCommand(context: ActionContext<State, State>, cmd: Pa
 export declare function playerAnswered(context: ActionContext<State, State>, choiceIndex: number): Promise<void>;
 export declare function runChoice(context: ActionContext<State, State>, cmd: Parser.Command): Promise<void>;
 export declare function textCommand(commit: Commit, dialog: DialogKey): Promise<void>;
-export declare function nextLine({ state, getters, dispatch, commit, }: ActionContext<State, State>): Promise<any>;
-export declare function finishGame(commit: Commit): void;
+export declare function nextLine(ctx: ActionContext<State, State>): Promise<any>;
+export declare function finishGame({ commit, state }: ActionContext<State, State>): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "narrat narrative engine",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",