narrat 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Narrat changelog
 
+## 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.7.1 - April 26, 2022 12:31:17
 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';
@@ -4197,8 +4197,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 +4221,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 = {}) {
@@ -4850,12 +4872,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, options.audio);
+                    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 {
+                    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':
@@ -4942,7 +4988,7 @@ async function playerAnswered(context, choiceIndex) {
             const dialog = {
                 speaker: 'player',
                 text: playerText,
-                interactive: true,
+                interactive: false,
             };
             commit('addDialog', { dialog });
             if (newBranch) {
@@ -5022,9 +5068,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 +5084,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 +5200,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 +5249,8 @@ const parserFunctions = {
     set_button: setButton,
     clear_dialog: clearDialog,
     play,
+    stop,
+    pause,
     wait,
     text,
     add_level,
@@ -5478,6 +5547,7 @@ function setupStore(options) {
             },
             notifications: {},
             hudStats: {},
+            options,
         },
         getters: {
             machineHead(state) {
@@ -5732,7 +5802,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.7.1 - April 26, 2022 12:31:17', '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.7.1 - April 26, 2022 12:31:17
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -4201,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);
@@ -4221,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 = {}) {
@@ -4854,12 +4876,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, options.audio);
+                    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 {
+                    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':
@@ -4946,7 +4992,7 @@ async function playerAnswered(context, choiceIndex) {
             const dialog = {
                 speaker: 'player',
                 text: playerText,
-                interactive: true,
+                interactive: false,
             };
             commit('addDialog', { dialog });
             if (newBranch) {
@@ -5026,9 +5072,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 +5088,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 +5204,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 +5253,8 @@ const parserFunctions = {
     set_button: setButton,
     clear_dialog: clearDialog,
     play,
+    stop,
+    pause,
     wait,
     text,
     add_level,
@@ -5482,6 +5551,7 @@ function setupStore(options) {
             },
             notifications: {},
             hudStats: {},
+            options,
         },
         getters: {
             machineHead(state) {
@@ -5736,7 +5806,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.7.1 - April 26, 2022 12:31:17', 'background: #222; color: #bada55');
     const storeSetup = setupStore(options);
     store$1 = storeSetup.store;
     app = vue.createApp(script$8, {

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/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.7.1",
   "description": "narrat narrative engine",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",