narraleaf-react 0.9.0-beta.5 → 0.9.1

package/README.md

@@ -1,147 +1,165 @@
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-transparent.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-light.png">
-  <img alt="NarraLeaf Logo" src="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-light.png">
-</picture>
-
-<h1 align="center">NarraLeaf-React</h1>
-
-<h4 align="center">A React visual novel player framework</h3>
-
-<p align="center">English | <a href="docs/README.zh-CN.md">简体中文</a></p>
-
-
-## What is NarraLeaf-React?
-
-NarraLeaf-React is a lightweight front-end visual novel player.  
-NL focuses on visual novel playing, so the user interface can be customized very easily.
-
-It doesn't use any rendering libraries and can be used on any web platform (e.g. Electron)
-
-## Why NarraLeaf-React?
-
-- **Lightweight**: NarraLeaf-React is a front-end framework, and it doesn't use any rendering libraries.
-- **Customizable**: You can customize the UI as you like, even replace the whole components.
-- **Easy to use**: It is easy to use and has a simple API that is built for developers. Based on OOP principles.
-
-### Scripting
-
-NarraLeaf-React uses TypeScript for all scripting, so you don't have to learn a whole new language to use it.
-
-It also has a highly abstracted and easy-to-use API, for example:
-
-```typescript
-import {Character, Menu, Scene, c, b} from "narraleaf-react";
-```
-
-```typescript
-const scene1 = new Scene("Scene1: Hello World", {
-  background: "/link/to/background.jpg",
-});
-
-const jS = new Character("John Smith");
-const jD = new Character("John Doe");
-
-scene1.action([
-  jS`Hello, world!`,
-  jS`This is my first ${b("NarraLeaf")} story.`,
-  jS`Start editing ${c("src/story.js", "#00f")} and enjoy the journey!`,
-
-  jD`Also, don't forget to check out the ${c("documentation", "#00f")}!`,
-
-  "By the way, the documentation is available on https://react.narraleaf.com/documentation",
-  "You can also visit the website for demo and more information.",
-
-  Menu.prompt("Start the journey")
-
-    .choose("Yes I will!", [
-      jS`Great! Let's start the journey!`,
-      jS`You can open issues on GitHub if you have any questions.`
-    ])
-
-    .choose("No, I'm going to check the documentation", [
-      jS`Sure! Take your time!`
-    ])
-]);
-```
-
-For more information, please visit [🛠React.NarraLeaf.com](https://react.narraleaf.com)
-
-## Get Started
-
-### Install
-
-```bash
-npm install narraleaf-react
-```
-
-### Documentation
-
-- [Introduction](https://react.narraleaf.com/documentation/introduction)
-- [Quick Start](https://react.narraleaf.com/documentation/quick-start)
-- [Installation](https://react.narraleaf.com/documentation/installation)
-- [Basic](https://react.narraleaf.com/documentation/basic)
-  - [Create a Scene](https://react.narraleaf.com/documentation/basic/create-scene)
-  - [Add Actions](https://react.narraleaf.com/documentation/basic/add-actions)
-  - [Show Dialog](https://react.narraleaf.com/documentation/basic/show-dialog)
-  - [Show Image](https://react.narraleaf.com/documentation/basic/show-image)
-  - [Play Story](https://react.narraleaf.com/documentation/basic/play-story)
-  - [Make Choices](https://react.narraleaf.com/documentation/basic/make-choices)
-  - [Play Sound](https://react.narraleaf.com/documentation/basic/sound)
-  - [Store Data](https://react.narraleaf.com/documentation/basic/store-data)
-  - [Conditional](https://react.narraleaf.com/documentation/basic/conditional)
-  - [Voice](https://react.narraleaf.com/documentation/basic/voice)
-  - [Manage Preferences](https://react.narraleaf.com/documentation/basic/manage-preferences)
-- [Solutions](https://react.narraleaf.com/documentation/solutions)
-  - [Customizing the font](https://react.narraleaf.com/documentation/solutions/font)
-  - [Migration from Ren'Py](https://react.narraleaf.com/documentation/solutions/from-renpy)
-- [Core](https://react.narraleaf.com/documentation/core)
-  - [Elements](https://react.narraleaf.com/documentation/core/elements)
-    - [Scene](https://react.narraleaf.com/documentation/core/elements/scene)
-    - [Character](https://react.narraleaf.com/documentation/core/elements/character)
-      - [Sentence](https://react.narraleaf.com/documentation/core/elements/character/sentence)
-      - [Word](https://react.narraleaf.com/documentation/core/elements/character/word)
-      - [Pause](https://react.narraleaf.com/documentation/core/elements/character/pause)
-    - [Image](https://react.narraleaf.com/documentation/core/elements/image)
-    - [Sound](https://react.narraleaf.com/documentation/core/elements/sound)
-    - [Menu](https://react.narraleaf.com/documentation/core/elements/menu)
-    - [Script](https://react.narraleaf.com/documentation/core/elements/script)
-    - [Condition](https://react.narraleaf.com/documentation/core/elements/condition)
-    - [Control](https://react.narraleaf.com/documentation/core/elements/control)
-    - [Text](https://react.narraleaf.com/documentation/core/elements/text)
-    - [Persistent](https://react.narraleaf.com/documentation/core/elements/persistent)
-    - [Story](https://react.narraleaf.com/documentation/core/elements/story)
-    - [Displayable](https://react.narraleaf.com/documentation/core/elements/displayable)
-    - [Layer](https://react.narraleaf.com/documentation/core/elements/layer)
-    - [Service](https://react.narraleaf.com/documentation/core/elements/service)
-    - [Video](https://react.narraleaf.com/documentation/core/elements/video)
-  - [Animation](https://react.narraleaf.com/documentation/core/animation)
-  - [Game](https://react.narraleaf.com/documentation/core/game)
-  - [Plugin](https://react.narraleaf.com/documentation/core/plugin)
-  - [Utils](https://react.narraleaf.com/documentation/core/utils)
-- [Player](https://react.narraleaf.com/documentation/player)
-  - [Player](https://react.narraleaf.com/documentation/player/player)
-  - [GameProviders](https://react.narraleaf.com/documentation/player/game-providers)
-  - Hooks
-  - [LayoutRouter](https://react.narraleaf.com/documentation/player/page-router)
-  - [Dialog](https://react.narraleaf.com/documentation/player/dialog)
-  - [Notification](https://react.narraleaf.com/documentation/player/notification)
-  - [Menu](https://react.narraleaf.com/documentation/player/menu)
-- About
-  - [License](https://react.narraleaf.com/documentation/info/license)
-  - [Incompatible Changes](https://react.narraleaf.com/documentation/info/incompatible-changes)
-
-Read more in [🛠React.NarraLeaf.com](https://react.narraleaf.com)
-
-## License
-
-> NarraLeaf-React is licensed under the MPL-2.0 License.
->
-> We updated the license to MPL-2.0 on 2024-9-24.
-
-## Contributing
-
-We welcome all contributions.  
-If you have any ideas, just open an issue or a pull request.
-
-
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-transparent.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-light.png">
+  <img alt="NarraLeaf Logo" src="https://raw.githubusercontent.com/NarraLeaf/.github/refs/heads/master/doc/banner-md-light.png">
+</picture>
+
+<h1 align="center">NarraLeaf-React</h1>
+
+<h4 align="center">A React visual novel player framework</h4>
+
+<p align="center">English | <a href="docs/README.zh-CN.md">简体中文</a></p>
+
+
+## What is NarraLeaf-React?
+
+NarraLeaf-React is a lightweight front-end visual novel player.  
+NL focuses on visual novel playing, so the user interface can be customized very easily.
+
+It doesn't use any rendering libraries and can be used on any web platform (e.g. Electron)
+
+## Why NarraLeaf-React?
+
+- **Lightweight**: NarraLeaf-React is a front-end framework, and it doesn't use any rendering libraries.
+- **Customizable**: You can customize the UI as you like, even replace the whole components.
+- **Easy to use**: It is easy to use and has a simple API that is built for developers. Based on OOP principles.
+
+### Scripting
+
+NarraLeaf-React uses TypeScript for all scripting, so you don't have to learn a whole new language to use it.
+
+It also has a highly abstracted and easy-to-use API, for example:
+
+```typescript
+import {Character, Menu, Scene, c, b} from "narraleaf-react";
+```
+
+```typescript
+const scene1 = new Scene("Scene1: Hello World", {
+  background: "/link/to/background.jpg",
+});
+
+const jS = new Character("John Smith");
+const jD = new Character("John Doe");
+
+scene1.action([
+  jS`Hello, world!`,
+  jS`This is my first ${b("NarraLeaf")} story.`,
+  jS`Start editing ${c("src/story.js", "#00f")} and enjoy the journey!`,
+
+  jD`Also, don't forget to check out the ${c("documentation", "#00f")}!`,
+
+  "By the way, the documentation is available on https://www.narraleaf.com/docs/narraleaf-react",
+  "You can also visit the website for demo and more information.",
+
+  Menu.prompt("Start the journey")
+
+    .choose("Yes I will!", [
+      jS`Great! Let's start the journey!`,
+      jS`You can open issues on GitHub if you have any questions.`
+    ])
+
+    .choose("No, I'm going to check the documentation", [
+      jS`Sure! Take your time!`
+    ])
+]);
+```
+
+For more information, please visit the [NarraLeaf-React documentation](https://www.narraleaf.com/docs/narraleaf-react).
+
+## Get Started
+
+### Install
+
+```bash
+npm install narraleaf-react
+```
+
+### Documentation
+
+- [Introduction](https://www.narraleaf.com/docs/narraleaf-react)
+- [Quick Start](https://www.narraleaf.com/docs/narraleaf-react/quick-start)
+- [Installation](https://www.narraleaf.com/docs/narraleaf-react/installation)
+- [Basic](https://www.narraleaf.com/docs/narraleaf-react/basic)
+  - [Create a Scene](https://www.narraleaf.com/docs/narraleaf-react/basic/create-scene)
+  - [Add Actions](https://www.narraleaf.com/docs/narraleaf-react/basic/add-actions)
+  - [Show Dialog](https://www.narraleaf.com/docs/narraleaf-react/basic/show-dialog)
+  - [Show Image](https://www.narraleaf.com/docs/narraleaf-react/basic/show-image)
+  - [Play Story](https://www.narraleaf.com/docs/narraleaf-react/basic/play-story)
+  - [Make Choices](https://www.narraleaf.com/docs/narraleaf-react/basic/make-choices)
+  - [Play Sound](https://www.narraleaf.com/docs/narraleaf-react/basic/sound)
+  - [Store Data](https://www.narraleaf.com/docs/narraleaf-react/basic/store-data)
+  - [Conditional](https://www.narraleaf.com/docs/narraleaf-react/basic/conditional)
+  - [Voice](https://www.narraleaf.com/docs/narraleaf-react/basic/voice)
+  - [Manage Preferences](https://www.narraleaf.com/docs/narraleaf-react/basic/manage-preferences)
+- [Solutions](https://www.narraleaf.com/docs/narraleaf-react/solutions)
+  - [Customizing the Font](https://www.narraleaf.com/docs/narraleaf-react/solutions/font)
+  - [Migration from Ren'Py](https://www.narraleaf.com/docs/narraleaf-react/solutions/from-renpy)
+  - [Quick Menu](https://www.narraleaf.com/docs/narraleaf-react/solutions/quick-menu)
+  - [Dialog Avatar](https://www.narraleaf.com/docs/narraleaf-react/solutions/dialog-avatar)
+  - [Custom Dialog](https://www.narraleaf.com/docs/narraleaf-react/solutions/custom-dialog)
+  - [Custom NVL Dialog](https://www.narraleaf.com/docs/narraleaf-react/solutions/custom-nvl-dialog)
+  - [Custom Menu](https://www.narraleaf.com/docs/narraleaf-react/solutions/custom-menu)
+  - [Page Overlay Settings](https://www.narraleaf.com/docs/narraleaf-react/solutions/page-overlay-settings)
+  - [Save System with localStorage](https://www.narraleaf.com/docs/narraleaf-react/solutions/save-system-localstorage)
+  - [Custom Notification](https://www.narraleaf.com/docs/narraleaf-react/solutions/custom-notification)
+  - [Gallery Service with localStorage](https://www.narraleaf.com/docs/narraleaf-react/solutions/gallery-service-localstorage)
+- [Core](https://www.narraleaf.com/docs/narraleaf-react/core)
+  - [Elements](https://www.narraleaf.com/docs/narraleaf-react/core/elements)
+    - [Scene](https://www.narraleaf.com/docs/narraleaf-react/core/elements/scene)
+    - [Character](https://www.narraleaf.com/docs/narraleaf-react/core/elements/character)
+      - [Sentence](https://www.narraleaf.com/docs/narraleaf-react/core/elements/character/sentence)
+      - [Word](https://www.narraleaf.com/docs/narraleaf-react/core/elements/character/word)
+      - [Pause](https://www.narraleaf.com/docs/narraleaf-react/core/elements/character/pause)
+    - [Image](https://www.narraleaf.com/docs/narraleaf-react/core/elements/image)
+    - [Sound](https://www.narraleaf.com/docs/narraleaf-react/core/elements/sound)
+    - [Menu](https://www.narraleaf.com/docs/narraleaf-react/core/elements/menu)
+    - [Script](https://www.narraleaf.com/docs/narraleaf-react/core/elements/script)
+    - [Condition](https://www.narraleaf.com/docs/narraleaf-react/core/elements/condition)
+    - [Control](https://www.narraleaf.com/docs/narraleaf-react/core/elements/control)
+    - [Text](https://www.narraleaf.com/docs/narraleaf-react/core/elements/text)
+    - [Persistent](https://www.narraleaf.com/docs/narraleaf-react/core/elements/persistent)
+    - [Story](https://www.narraleaf.com/docs/narraleaf-react/core/elements/story)
+    - [Displayable](https://www.narraleaf.com/docs/narraleaf-react/core/elements/displayable)
+    - [Layer](https://www.narraleaf.com/docs/narraleaf-react/core/elements/layer)
+    - [Service](https://www.narraleaf.com/docs/narraleaf-react/core/elements/service)
+    - [Video](https://www.narraleaf.com/docs/narraleaf-react/core/elements/video)
+    - [Built-in Gallery](https://www.narraleaf.com/docs/narraleaf-react/core/elements/built-in/gallery)
+  - [Animation](https://www.narraleaf.com/docs/narraleaf-react/core/animation)
+    - [Transform](https://www.narraleaf.com/docs/narraleaf-react/core/animation/transform)
+    - [Transitions](https://www.narraleaf.com/docs/narraleaf-react/core/animation/transition)
+  - [Game](https://www.narraleaf.com/docs/narraleaf-react/core/game)
+    - [LiveGame](https://www.narraleaf.com/docs/narraleaf-react/core/game/live-game)
+    - [Storable](https://www.narraleaf.com/docs/narraleaf-react/core/game/storable)
+    - [Preference](https://www.narraleaf.com/docs/narraleaf-react/core/game/preference/preference)
+    - [Key Map](https://www.narraleaf.com/docs/narraleaf-react/core/game/key-map)
+    - [Hooks](https://www.narraleaf.com/docs/narraleaf-react/core/game/hooks)
+  - [Plugin](https://www.narraleaf.com/docs/narraleaf-react/core/plugin)
+  - [Utils](https://www.narraleaf.com/docs/narraleaf-react/core/utils)
+- [Player](https://www.narraleaf.com/docs/narraleaf-react/player)
+  - [Player](https://www.narraleaf.com/docs/narraleaf-react/player/player)
+  - [FixedAspectRatioContainer](https://www.narraleaf.com/docs/narraleaf-react/player/fixed-aspect-ratio-container)
+  - [GameProviders](https://www.narraleaf.com/docs/narraleaf-react/player/game-providers)
+  - [Hooks](https://www.narraleaf.com/docs/narraleaf-react/player/hooks)
+  - [LayoutRouter](https://www.narraleaf.com/docs/narraleaf-react/player/page-router)
+  - [Dialog](https://www.narraleaf.com/docs/narraleaf-react/player/dialog)
+  - [Notification](https://www.narraleaf.com/docs/narraleaf-react/player/notification)
+  - [Menu](https://www.narraleaf.com/docs/narraleaf-react/player/menu)
+  - [NvlContainer](https://www.narraleaf.com/docs/narraleaf-react/player/nvl-container)
+- About
+  - [License](https://www.narraleaf.com/docs/narraleaf-react/info/license)
+  - [Incompatible Changes](https://www.narraleaf.com/docs/narraleaf-react/info/incompatible-changes)
+
+Read more in the [NarraLeaf-React documentation](https://www.narraleaf.com/docs/narraleaf-react).
+
+## License
+
+> NarraLeaf-React is licensed under the MPL-2.0 License.
+>
+> We updated the license to MPL-2.0 on 2024-9-24.
+
+## Contributing
+
+We welcome all contributions.  
+If you have any ideas, just open an issue or a pull request.
+

package/dist/built-in.d.ts

@@ -0,0 +1,3 @@
+export { Gallery, DevTools, } from "narraleaf-react";
+export { blink, effectLayer, vignette, } from "./game/nlcore/elements/built-in/screenEffects";
+export type { BlinkOptions, EffectLayerOptions, ScreenEffectColor, VignetteOptions, } from "./game/nlcore/elements/built-in/screenEffects";

package/dist/built-in.js

@@ -0,0 +1 @@
+import{Gallery as L,DevTools as S}from"narraleaf-react";import{Control as r,Image as b,Layer as T,Transform as h}from"narraleaf-react";var d=new WeakMap;function y(e,t={}){let n=d.get(e);if(n)return n;let o=new T(t.name??"[[Effect Layer of "+e.config.name+"]]",{zIndex:t.zIndex??1e3});return e.config.layers.push(o),d.set(e,o),o}function k(e,t={}){let{closeDuration:n=180,hold:o=100,openDuration:p=220,easing:i="easeInOut",color:l="#000"}=t,f=y(e),a=u("[[Blink Top of "+e.config.name+"]]",l,f),s=u("[[Blink Bottom of "+e.config.name+"]]",l,f);return r.do([r.all([a.transform(c([[{opacity:1,clipPath:"inset(0 0 100% 0)"},{duration:0}],[{clipPath:"inset(0 0 50% 0)"},{duration:n,ease:i}]])),s.transform(c([[{opacity:1,clipPath:"inset(100% 0 0 0)"},{duration:0}],[{clipPath:"inset(50% 0 0 0)"},{duration:n,ease:i}]]))]),...o>0?[r.sleep(o)]:[],r.all([a.transform(c([[{clipPath:"inset(0 0 50% 0)"},{duration:0}],[{clipPath:"inset(0 0 100% 0)"},{duration:p,ease:i}],[{opacity:0,clipPath:"inset(0 0 100% 0)"},{duration:0}]])),s.transform(c([[{clipPath:"inset(50% 0 0 0)"},{duration:0}],[{clipPath:"inset(100% 0 0 0)"},{duration:p,ease:i}],[{opacity:0,clipPath:"inset(100% 0 0 0)"},{duration:0}]]))]),r.all([r.do([a.opacity(0,0),a.clearClip({duration:0})]),r.do([s.opacity(0,0),s.clearClip({duration:0})])])])}function E(e,t={}){let{duration:n=300,opacity:o=.72,color:p="#000",inner:i="44%",outer:l="78%",hold:f=600,easing:a="easeInOut"}=t,s=y(e),m=u("[[Vignette of "+e.config.name+"]]",p,s),g=`radial-gradient(circle at center, transparent ${i}, black ${l})`;return r.do([m.transform(c([[{opacity:0,maskImage:g,maskSize:"100% 100%",maskPosition:"center",maskRepeat:"no-repeat",maskMode:"alpha"},{duration:0}],[{opacity:o},{duration:n,ease:a}]])),...f>0?[r.sleep(f)]:[],m.transform(c([[{opacity:0},{duration:n,ease:a}]])),m.clearMask({duration:0})])}function u(e,t,n){return new b({name:e,src:t,autoFit:!0,opacity:0,layer:n})}function c(e){return new h(e.map(([t,n])=>({props:t,options:n})))}export{S as DevTools,L as Gallery,k as blink,y as effectLayer,E as vignette};

package/dist/game/nlcore/action/action.d.ts

@@ -1,10 +1,10 @@
-import { LogicAction } from "./logicAction";
+import type { LogicAction } from "./logicAction";
 import { ContentNode } from "../action/tree/actionTree";
 import type { CalledActionResult } from "../gameTypes";
-import { Awaitable } from "../../../util/data";
-import { GameState } from "../../player/gameState";
-import { Story } from "../elements/story";
-import { ActionSearchOptions } from "../types";
+import type { Awaitable } from "../../../util/data";
+import type { GameState } from "../../player/gameState";
+import type { Story } from "../elements/story";
+import type { ActionSearchOptions } from "../types";
 import type { StackModel } from "./stackModel";
 export type ActionExecutionInjection = {
     stackModel: StackModel;
@@ -18,11 +18,15 @@ export declare class Action<ContentNodeType = any, Callee = LogicAction.GameElem
     type: Type;
     contentNode: ContentNode<ContentNodeType>;
     _id: string;
+    private _staticId;
     readonly __stack: string;
     constructor(callee: Callee, type: Type, contentNode: ContentNode<ContentNodeType>);
     executeAction(_state: GameState, _injection: ActionExecutionInjection): ExecutedActionResult;
     getId(): string;
     setId(id: string): void;
+    getStaticId(): string | null;
+    setStaticId(id: string | null): this;
+    resolveId(generatedId: string): this;
     setContent(content: ContentNodeType): this;
     setContentNode(contentNode: ContentNode<ContentNodeType>): this;
     getFutureActions(_story: Story, _options: ActionSearchOptions): LogicAction.Actions[];

package/dist/game/nlcore/action/actionTypes.d.ts

@@ -1,20 +1,20 @@
-import { LogicAction } from "../action/logicAction";
+import type { LogicAction } from "../action/logicAction";
 import type { Story } from "../elements/story";
 import type { ConditionData, Lambda } from "../elements/condition";
-import { Color, ImageSrc } from "../types";
-import { Transform } from "../elements/transform/transform";
+import type { Color, ImageSrc } from "../types";
+import type { Transform } from "../elements/transform/transform";
 import type { Scene } from "../elements/scene";
 import type { MenuData } from "../elements/menu";
-import { Awaitable, FlexibleTuple, SelectElementFromEach } from "../../../util/data";
+import type { Awaitable, FlexibleTuple, SelectElementFromEach } from "../../../util/data";
 import type { Sound } from "../elements/sound";
 import type { Script } from "../elements/script";
-import { Sentence } from "../elements/character/sentence";
+import type { Sentence } from "../elements/character/sentence";
 import type { TransformDefinitions } from "../elements/transform/type";
-import { Image, TagGroupDefinition } from "../elements/displayable/image";
-import { FadeOptions } from "../elements/type";
-import { Transition } from "../elements/transition/transition";
-import { ImageTransition } from "../elements/transition/transitions/image/imageTransition";
-import { Layer } from "../elements/layer";
+import type { Image, TagGroupDefinition } from "../elements/displayable/image";
+import type { FadeOptions } from "../elements/type";
+import type { Transition } from "../elements/transition/transition";
+import type { ImageTransition } from "../elements/transition/transitions/image/imageTransition";
+import type { Layer } from "../elements/layer";
 export declare const DisplayableActionTypes: {
     readonly action: "displayable:action";
     readonly applyTransform: "displayable:applyTransform";
@@ -40,9 +40,17 @@ export declare const SceneActionTypes: {
     readonly setBackgroundMusic: "scene:setBackgroundMusic";
     readonly preUnmount: "scene:preUnmount";
     readonly transitionToScene: "scene:transitionToScene";
+    readonly nvlBlock: "scene:nvlBlock";
+    readonly nvlShow: "scene:nvlShow";
+    readonly nvlHide: "scene:nvlHide";
+    readonly nvlEnd: "scene:nvlEnd";
+};
+export type NvlBlockOptions = {
+    showTransition?: Partial<TransformDefinitions.CommonTransformProps>;
+    hideTransition?: Partial<TransformDefinitions.CommonTransformProps>;
 };
 export type SceneActionContentType = {
-    [K in typeof SceneActionTypes[keyof typeof SceneActionTypes]]: K extends typeof SceneActionTypes["action"] ? Scene : K extends typeof SceneActionTypes["init"] ? [Scene] : K extends typeof SceneActionTypes["exit"] ? [] : K extends typeof SceneActionTypes["jumpTo"] ? [Scene] : K extends typeof SceneActionTypes["setBackgroundMusic"] ? [Sound | null, number?] : K extends typeof SceneActionTypes["preUnmount"] ? [] : K extends typeof SceneActionTypes["transitionToScene"] ? [ImageTransition, Scene | undefined, ImageSrc | Color | undefined] : any;
+    [K in typeof SceneActionTypes[keyof typeof SceneActionTypes]]: K extends typeof SceneActionTypes["action"] ? Scene : K extends typeof SceneActionTypes["init"] ? [Scene] : K extends typeof SceneActionTypes["exit"] ? [] : K extends typeof SceneActionTypes["jumpTo"] ? [Scene] : K extends typeof SceneActionTypes["setBackgroundMusic"] ? [Sound | null, number?] : K extends typeof SceneActionTypes["preUnmount"] ? [] : K extends typeof SceneActionTypes["transitionToScene"] ? [ImageTransition, Scene | undefined, ImageSrc | Color | undefined] : K extends typeof SceneActionTypes["nvlBlock"] ? [LogicAction.Actions[], NvlBlockOptions] : K extends typeof SceneActionTypes["nvlShow"] ? [Partial<TransformDefinitions.CommonTransformProps>?] : K extends typeof SceneActionTypes["nvlHide"] ? [Partial<TransformDefinitions.CommonTransformProps>?] : K extends typeof SceneActionTypes["nvlEnd"] ? [NvlBlockOptions?] : any;
 };
 export declare const StoryActionTypes: {
     readonly action: "story:action";
@@ -103,9 +111,10 @@ export declare const ControlActionTypes: {
     readonly while: "control:while";
     readonly break: "control:break";
     readonly sleep: "control:sleep";
+    readonly waitForClick: "control:waitForClick";
 };
 export type ControlActionContentType = {
-    [K in typeof ControlActionTypes[keyof typeof ControlActionTypes]]: K extends "control:do" ? [LogicAction.Actions[]] : K extends "control:doAsync" ? [LogicAction.Actions[]] : K extends "control:any" ? [LogicAction.Actions[]] : K extends "control:all" ? [LogicAction.Actions[]] : K extends "control:parallel" ? [LogicAction.Actions[]] : K extends "control:allAsync" ? [LogicAction.Actions[]] : K extends "control:repeat" ? [LogicAction.Actions[], number] : K extends "control:while" ? [LogicAction.Actions[], Lambda<boolean>] : K extends "control:break" ? [] : K extends "control:sleep" ? [LogicAction.Actions[], number | Awaitable<any> | Promise<any>] : any;
+    [K in typeof ControlActionTypes[keyof typeof ControlActionTypes]]: K extends "control:do" ? [LogicAction.Actions[]] : K extends "control:doAsync" ? [LogicAction.Actions[]] : K extends "control:any" ? [LogicAction.Actions[]] : K extends "control:all" ? [LogicAction.Actions[]] : K extends "control:parallel" ? [LogicAction.Actions[]] : K extends "control:allAsync" ? [LogicAction.Actions[]] : K extends "control:repeat" ? [LogicAction.Actions[], number] : K extends "control:while" ? [LogicAction.Actions[], Lambda<boolean>] : K extends "control:break" ? [] : K extends "control:sleep" ? [LogicAction.Actions[], number | Awaitable<any> | Promise<any>] : K extends "control:waitForClick" ? [] : any;
 };
 export declare const TextActionTypes: {
     readonly action: "text:action";

package/dist/game/nlcore/action/actions/controlAction.d.ts

@@ -19,6 +19,7 @@ export declare class ControlAction<T extends typeof ControlActionTypes[keyof typ
         readonly while: "control:while";
         readonly break: "control:break";
         readonly sleep: "control:sleep";
+        readonly waitForClick: "control:waitForClick";
     };
     static executeActionsAsync(gameState: GameState, action: LogicAction.Actions): Awaitable<void>;
     checkActionChain(actions: LogicAction.Actions[]): LogicAction.Actions[];

package/dist/game/nlcore/action/actions/menuAction.d.ts

@@ -12,10 +12,7 @@ export declare class MenuAction<T extends typeof MenuActionTypes[keyof typeof Me
     static ActionTypes: {
         readonly action: "menu:action";
     };
-    executeAction(gameState: GameState, injection: ActionExecutionInjection): (Awaitable<CalledActionResult, CalledActionResult> | {
-        type: T;
-        node: import("../../action/tree/actionTree").RenderableNode | null;
-    })[];
+    executeAction(gameState: GameState, injection: ActionExecutionInjection): Awaitable<CalledActionResult, CalledActionResult>;
     getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
     stringify(_story: Story, _seen: Set<LogicAction.Actions>, _strict: boolean): string;
 }

package/dist/game/nlcore/action/actions/sceneAction.d.ts

@@ -10,9 +10,10 @@ import { Story } from "../../elements/story";
 import { ImageTransition } from "../../elements/transition/transitions/image/imageTransition";
 import { ActionSearchOptions } from "../../types";
 import { ExposedState, ExposedStateType } from "../../../player/type";
+import type { TransformDefinitions } from "../../elements/transform/type";
 import { ImageDataRaw } from "../../elements/displayable/image";
 import { ActionExecutionInjection, ExecutedActionResult } from "../action";
-type SceneSnapshot = {
+export type SceneSnapshot = {
     state: SceneDataRaw | null;
     local: Record<string, any>;
     element: PlayerStateElementSnapshot;
@@ -27,6 +28,10 @@ export declare class SceneAction<T extends typeof SceneActionTypes[keyof typeof
         readonly setBackgroundMusic: "scene:setBackgroundMusic";
         readonly preUnmount: "scene:preUnmount";
         readonly transitionToScene: "scene:transitionToScene";
+        readonly nvlBlock: "scene:nvlBlock";
+        readonly nvlShow: "scene:nvlShow";
+        readonly nvlHide: "scene:nvlHide";
+        readonly nvlEnd: "scene:nvlEnd";
     };
     static handleSceneInit(scene: Scene, next: CalledActionResult, state: GameState, awaitable: Awaitable<CalledActionResult, any>): {
         type: any;
@@ -43,10 +48,10 @@ export declare class SceneAction<T extends typeof SceneActionTypes[keyof typeof
     static restoreSceneSnapshot(snapshot: SceneSnapshot, state: GameState): void;
     applyTransition(gameState: GameState, transition: ImageTransition, injection: ActionExecutionInjection): Awaitable<CalledActionResult, CalledActionResult>;
     exit(state: GameState): void;
+    applyNvlVisibility(gameState: GameState, visible: boolean, options: Partial<TransformDefinitions.CommonTransformProps> | undefined, injection: ActionExecutionInjection): CalledActionResult | Awaitable<CalledActionResult, CalledActionResult>;
     executeAction(gameState: GameState, injection: ActionExecutionInjection): ExecutedActionResult;
     getFutureActions(story: Story, searchOptions?: ActionSearchOptions): LogicAction.Actions[];
     _sceneNotFoundError(sceneId: string): Error;
     getSceneName(scene: Scene | string): string;
     stringify(story: Story, seen: Set<LogicAction.Actions>, _strict: boolean): string;
 }
-export {};

package/dist/game/nlcore/action/logicAction.d.ts

@@ -5,39 +5,39 @@ import type { Image } from "../elements/displayable/image";
 import type { Condition } from "../elements/condition";
 import type { Script } from "../elements/script";
 import type { Menu } from "../elements/menu";
-import { StringKeyOf, Values } from "../../../util/data";
-import { TypedAction } from "../action/actions";
-import { Sound } from "../elements/sound";
-import { Control } from "../elements/control";
-import { CharacterActionContentType, CharacterActionTypes, ConditionActionContentType, ConditionActionTypes, ControlActionContentType, DisplayableActionContentType, DisplayableActionTypes, ImageActionContentType, ImageActionTypes, LayerActionContentType, LayerActionTypes, MenuActionContentType, MenuActionTypes, PersistentActionContentType, PersistentActionTypes, SceneActionContentType, SceneActionTypes, ScriptActionContentType, ScriptActionTypes, SoundActionContentType, StoryActionContentType, StoryActionTypes, TextActionContentType, VideoActionContentType, VideoActionTypes } from "../action/actionTypes";
-import { CharacterAction } from "../action/actions/characterAction";
-import { SceneAction } from "../action/actions/sceneAction";
-import { StoryAction } from "../action/actions/storyAction";
-import { ImageAction } from "../action/actions/imageAction";
-import { ConditionAction } from "../action/actions/conditionAction";
-import { ScriptAction } from "../action/actions/scriptAction";
-import { MenuAction } from "../action/actions/menuAction";
-import { SoundAction } from "../action/actions/soundAction";
-import { ControlAction } from "../action/actions/controlAction";
-import { Text } from "../elements/displayable/text";
-import { TextAction } from "../action/actions/textAction";
-import { Displayable as AbstractDisplayable } from "../elements/displayable/displayable";
-import { DisplayableAction } from "../action/actions/displayableAction";
-import { Persistent } from "../elements/persistent";
-import { PersistentAction } from "../action/actions/persistentAction";
-import { ServiceSkeleton } from "../elements/service";
-import { ServiceAction, ServiceActionContentType } from "../action/serviceAction";
-import { Layer } from "../elements/layer";
-import { LayerAction } from "../action/actions/layerAction";
-import { ExposedStateType } from "../../player/type";
-import { Video } from "../elements/video";
-import { VideoAction } from "../action/actions/videoAction";
+import type { StringKeyOf, Values } from "../../../util/data";
+import type { TypedAction } from "../action/actions";
+import type { Sound } from "../elements/sound";
+import type { Control } from "../elements/control";
+import { CharacterActionContentType, CharacterActionTypes, ConditionActionContentType, ConditionActionTypes, ControlActionContentType, ControlActionTypes, DisplayableActionContentType, DisplayableActionTypes, ImageActionContentType, ImageActionTypes, LayerActionContentType, LayerActionTypes, MenuActionContentType, MenuActionTypes, PersistentActionContentType, PersistentActionTypes, SceneActionContentType, SceneActionTypes, ScriptActionContentType, ScriptActionTypes, SoundActionContentType, SoundActionTypes, StoryActionContentType, StoryActionTypes, TextActionContentType, TextActionTypes, VideoActionContentType, VideoActionTypes } from "../action/actionTypes";
+import type { CharacterAction } from "../action/actions/characterAction";
+import type { SceneAction } from "../action/actions/sceneAction";
+import type { StoryAction } from "../action/actions/storyAction";
+import type { ImageAction } from "../action/actions/imageAction";
+import type { ConditionAction } from "../action/actions/conditionAction";
+import type { ScriptAction } from "../action/actions/scriptAction";
+import type { MenuAction } from "../action/actions/menuAction";
+import type { SoundAction } from "../action/actions/soundAction";
+import type { ControlAction } from "../action/actions/controlAction";
+import type { Text } from "../elements/displayable/text";
+import type { TextAction } from "../action/actions/textAction";
+import type { Displayable as AbstractDisplayable } from "../elements/displayable/displayable";
+import type { DisplayableAction } from "../action/actions/displayableAction";
+import type { Persistent } from "../elements/persistent";
+import type { PersistentAction } from "../action/actions/persistentAction";
+import type { ServiceSkeleton } from "../elements/service";
+import type { ServiceAction, ServiceActionContentType } from "../action/serviceAction";
+import type { Layer } from "../elements/layer";
+import type { LayerAction } from "../action/actions/layerAction";
+import type { ExposedStateType } from "../../player/type";
+import type { Video } from "../elements/video";
+import type { VideoAction } from "../action/actions/videoAction";
 export interface LogicActionInterface {
     DisplayableElements: Text | Image | Layer | AbstractDisplayable<any, any>;
     DisplayableExposed: ExposedStateType.image | ExposedStateType.layer | ExposedStateType.text;
     GameElement: Character | Scene | Story | Image | Condition | Script | Menu | Sound | Control | Text | AbstractDisplayable<any, any> | Persistent<any> | ServiceSkeleton | Video;
     Actions: TypedAction | CharacterAction | ConditionAction | ImageAction | SceneAction | ScriptAction | StoryAction | MenuAction | SoundAction | ControlAction | TextAction | DisplayableAction | PersistentAction | ServiceAction | LayerAction | VideoAction;
-    ActionTypes: Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundAction.ActionTypes> | Values<typeof ControlAction.ActionTypes> | Values<typeof TextAction.ActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
+    ActionTypes: Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundActionTypes> | Values<typeof ControlActionTypes> | Values<typeof TextActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
     ActionContents: CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType & VideoActionContentType;
 }
 export declare const LogicAction: {};
@@ -46,7 +46,7 @@ export declare namespace LogicAction {
     type DisplayableExposed = ExposedStateType.image | ExposedStateType.layer | ExposedStateType.text;
     type GameElement = Character | Scene | Story | Image | Condition | Script | Menu | Sound | Control | Text | AbstractDisplayable<any, any> | Persistent<any> | ServiceSkeleton | Video;
     type Actions = TypedAction | CharacterAction | ConditionAction | ImageAction | SceneAction | ScriptAction | StoryAction | MenuAction | SoundAction | ControlAction | TextAction | DisplayableAction | PersistentAction | ServiceAction | LayerAction | VideoAction;
-    type ActionTypes = Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundAction.ActionTypes> | Values<typeof ControlAction.ActionTypes> | Values<typeof TextAction.ActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
+    type ActionTypes = Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundActionTypes> | Values<typeof ControlActionTypes> | Values<typeof TextActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
     type ActionContents = CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType & VideoActionContentType;
 }
 export type LogicAction = typeof LogicAction;

package/dist/game/nlcore/action/stackModel.d.ts

@@ -155,7 +155,7 @@ export declare class StackModel {
      *                 The undo/history system will then re-insert the action
      *                 manually (see LiveGame.undo) to avoid having two copies
      *                 of the same action after deserialisation.
-     * @returns Snapshot that can be passed to {@link StackModel.deserialize}.
+     * @returns Snapshot that can be passed to StackModel.deserialize.
      */
     serialize(frozen?: boolean): StackModelRawData;
     reset(): void;

package/dist/game/nlcore/common/elements.d.ts

@@ -1,4 +1,4 @@
-import { Character } from "../elements/character";
+import { Character, Narrator } from "../elements/character";
 import { Condition, Lambda } from "../elements/condition";
 import { Control } from "../elements/control";
 import { Image } from "../elements/displayable/image";
@@ -16,4 +16,7 @@ import { Persistent } from "../elements/persistent";
 import { Service } from "../elements/service";
 import { Layer } from "../elements/layer";
 import { Video } from "../elements/video";
-export { Character, Condition, Control, Image, Lambda, Menu, Scene, Script, Sentence, Sound, Story, Transform, Word, Text, Pause, Persistent, Service, Layer, Video, };
+import { NVLToken } from "../elements/nvl";
+export { Character, Narrator, Condition, Control, Image, Lambda, Menu, NVLToken, Scene, Script, Sentence, Sound, Story, Transform, Word, Text, Pause, Persistent, Service, Layer, Video, };
+export type { SentenceMetadata } from "../elements/character/sentence";
+export type { CharacterPortraitConfig, DialogAvatar, DialogAvatarResolver, DialogAvatarResolverContext, DialogAvatarResolution, DialogAvatarSource, } from "../elements/character/avatar";