narraleaf-react 0.4.4 → 0.5.0

package/README.md

@@ -1,7 +1,7 @@
 <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="Fallback image description" src="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>
@@ -31,49 +31,36 @@ NarraLeaf-React uses TypeScript for all scripting, so you don't have to learn a
 It also has a highly abstracted and easy-to-use API, for example:
 
 ```typescript
-import {Character, Menu, Scene, Word, c, b} from "narraleaf-react";
+import {Character, Menu, Scene, c, b} from "narraleaf-react";
 ```
 
 ```typescript
-const scene1 = new Scene("scene1_hello_world", {
-  background: "/background/scene1_hello_world.jpg",
+const scene1 = new Scene("Scene1: Hello World", {
+  background: "/link/to/background.jpg",
 });
 
-const johnSmith = new Character("John Smith");
-const johnDoe = new Character("John Doe");
+const jS = new Character("John Smith");
+const jD = new Character("John Doe");
 
 scene1.action([
-  /**
-   * John Smith: Hello, world!
-   * John Smith: This is my first **NarraLeaf** story.
-   * John Smith: Start editing src/story.js and enjoy the journey!
-   */
-  johnSmith
-    .say("Hello, world!")
-    .say`This is my first ${b("NarraLeaf")} story.`
-    .say`Start editing ${c("src/story.js", "#00f")} and enjoy the journey!`,
-
-  /**
-   * John Doe: Also, don't forget to check out the documentation!
-   */
-  johnDoe.say("Also, don't forget to check out the documentation!"),
-    
-  /**
-   * Menu: Start the journey
-   *   > Yes I will!
-   *     - John Smith: Great! Let's start the journey!
-   *     - John Smith: You can open issues on GitHub if you have any questions.
-   *   > No, I'm going to check the documentation
-   *     - John Smith: Sure! Take your time!
-   */
+  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!", [
-      johnSmith
-        .say("Great! Let's start the journey!")
-        .say("You can open issues on GitHub if you have any questions.")
+      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", [
-      johnSmith.say("Sure! Take your time!")
+      jS`Sure! Take your time!`
     ])
 ]);
 ```
@@ -133,6 +120,17 @@ npm install narraleaf-react
   - [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
+    - [useGame](https://react.narraleaf.com/documentation/player/hooks/useGame)
+    - [usePreferences](https://react.narraleaf.com/documentation/player/hooks/usePreferences)
+    - [useRouter](https://react.narraleaf.com/documentation/player/hooks/useRouter)
+    - [useDialog](https://react.narraleaf.com/documentation/player/hooks/useDialog)
+  - [Page Router](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)

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

@@ -2,6 +2,7 @@ import { Timeline } from "../../../game/player/Tasks";
 import { Action } from "./action";
 import { LiveGameEventToken } from "../types";
 import { LogicAction } from "../game";
+import { GameHistoryManager } from "./gameHistory";
 export type ActionHistory<T extends Array<unknown> = any> = {
     action: Action;
     timeline?: Timeline;
@@ -27,7 +28,8 @@ export declare class ActionHistoryManager {
      * @param id random id generated by push
      */
     undoUntil(id: string): LogicAction.Actions | null;
-    undo(): LogicAction.Actions | null;
+    undo(gameHistory: GameHistoryManager): LogicAction.Actions | null;
+    ableToUndo(gameHistory: GameHistoryManager): boolean;
     onUndo(callback: (affected: ActionHistory<any>[]) => void): LiveGameEventToken;
     offUndo(callback: (affected: ActionHistory<any>[]) => void): void;
     getHistory(): ActionHistory<any>[];

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

@@ -56,9 +56,10 @@ export declare const ImageActionTypes: {
     readonly flush: "image:flush";
     readonly initWearable: "image:initWearable";
     readonly setAppearance: "image:setAppearance";
+    readonly setDarkness: "image:setDarkness";
 };
 export type ImageActionContentType = {
-    [K in typeof ImageActionTypes[keyof typeof ImageActionTypes]]: K extends "image:setSrc" ? [ImageSrc | Color] : K extends "image:flush" ? [] : K extends "image:initWearable" ? [Image] : K extends "image:setAppearance" ? [FlexibleTuple<SelectElementFromEach<TagGroupDefinition>> | string[], ImageTransition | undefined] : any;
+    [K in typeof ImageActionTypes[keyof typeof ImageActionTypes]]: K extends "image:setSrc" ? [ImageSrc | Color] : K extends "image:flush" ? [] : K extends "image:initWearable" ? [Image] : K extends "image:setAppearance" ? [FlexibleTuple<SelectElementFromEach<TagGroupDefinition>> | string[], ImageTransition | undefined] : K extends "image:setDarkness" ? [darkness: number, duration?: number, easing?: TransformDefinitions.EasingDefinition] : any;
 } & DisplayableActionContentType<ImageTransition>;
 export declare const ConditionActionTypes: {
     readonly action: "condition:action";
@@ -121,9 +122,10 @@ export type PersistentActionContentType = {
 };
 export declare const LayerActionTypes: {
     readonly action: "layer:action";
+    readonly setZIndex: "layer:setZIndex";
 };
 export type LayerActionContentType = {
-    [K in typeof LayerActionTypes[keyof typeof LayerActionTypes]]: K extends "layer:action" ? any : any;
+    [K in typeof LayerActionTypes[keyof typeof LayerActionTypes]]: K extends "layer:action" ? any : K extends "layer:setZIndex" ? [number] : any;
 };
 export declare const VideoActionTypes: {
     readonly action: "video:action";

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

@@ -13,6 +13,7 @@ export declare class ImageAction<T extends typeof ImageActionTypes[keyof typeof
         readonly flush: "image:flush";
         readonly initWearable: "image:initWearable";
         readonly setAppearance: "image:setAppearance";
+        readonly setDarkness: "image:setDarkness";
     };
     static resolveTagSrc(image: Image, tags: string[]): string;
     static resolveCurrentSrc(image: Image): string | Color;

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

@@ -7,6 +7,7 @@ import { Layer } from "../../elements/layer";
 export declare class LayerAction<T extends Values<typeof LayerActionTypes> = Values<typeof LayerActionTypes>> extends TypedAction<LayerActionContentType, T, Layer> {
     static ActionTypes: {
         readonly action: "layer:action";
+        readonly setZIndex: "layer:setZIndex";
     };
-    executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
+    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
 }

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

@@ -3,15 +3,17 @@ import { ActionHistoryManager } from "./actionHistory";
 type GameHistoryAction = {
     token: string;
     action: Action;
+    isPending?: boolean;
 };
 type GameElementHistory = {
     type: "say";
     text: string;
     voice: string | null;
+    character: string | null;
 } | {
     type: "menu";
     text: string | null;
-    selected: string;
+    selected: string | null;
 };
 export type GameHistory = GameHistoryAction & {
     element: GameElementHistory;
@@ -23,6 +25,8 @@ export declare class GameHistoryManager {
     push(action: GameHistory): this;
     getHistory(): GameHistory[];
     reset(): void;
+    updateByToken(id: string, handler: (result: GameHistory | null) => void): void;
+    resolvePending(id: string): void;
     private crossFilter;
 }
 export {};

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

@@ -4,6 +4,6 @@ import { TransformDefinitions } from "../elements/transform/type";
 import { IGamePluginRegistry } from "../game/plugin/plugin";
 import { LiveGameEventToken } from "../types";
 import { GameHistory } from "../action/gameHistory";
-import { GameConfig } from "../gameTypes";
+import { GameConfig, SavedGame } from "../gameTypes";
 export * from "../elements/type";
-export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, };
+export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, SavedGame, };

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

@@ -49,3 +49,4 @@ export declare class Character extends Actionable<CharacterStateData, Character>
     apply(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
     apply(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
 }
+export declare const Narrator: Character;

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

@@ -1,20 +1,20 @@
 import { LogicAction } from "../action/logicAction";
 import { Actionable } from "../action/actionable";
-import { Chained, ChainedActions, Proxied } from "../action/chain";
-import { LambdaHandler } from "../elements/type";
+import { Chained, Proxied } from "../action/chain";
+import { LambdaHandler, ActionStatements } from "../elements/type";
 export declare class Lambda<T = any> {
 }
 export declare class Condition<Closed extends true | false = false> extends Actionable {
     /**
      * @chainable
      */
-    static If(condition: Lambda | LambdaHandler<boolean>, action: ChainedActions): Proxied<Condition, Chained<LogicAction.Actions>>;
+    static If(condition: Lambda | LambdaHandler<boolean>, action: ActionStatements): Proxied<Condition, Chained<LogicAction.Actions>>;
     /**
      * @chainable
      */
-    ElseIf(condition: Closed extends false ? (Lambda | LambdaHandler<boolean>) : never, action: Closed extends false ? ChainedActions : never): Closed extends false ? Proxied<Condition, Chained<LogicAction.Actions>> : never;
+    ElseIf(condition: Closed extends false ? (Lambda | LambdaHandler<boolean>) : never, action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition, Chained<LogicAction.Actions>> : never;
     /**
      * @chainable
      */
-    Else(action: Closed extends false ? ChainedActions : never): Closed extends false ? Proxied<Condition<true>, Chained<LogicAction.Actions>> : never;
+    Else(action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition<true>, Chained<LogicAction.Actions>> : never;
 }

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

@@ -1,37 +1,37 @@
 import { Actionable } from "../action/actionable";
 import { Awaitable } from "../../../util/data";
-import { ChainedActions } from "../action/chain";
+import { ActionStatements } from "./type";
 export declare class Control extends Actionable {
     /**
      * Execute actions in order, waiting for each action to complete
      * @chainable
      */
-    static do(actions: ChainedActions): ChainedControl;
+    static do(actions: ActionStatements): ChainedControl;
     /**
      * Execute actions in order, do not wait for this action to complete
      * @chainable
      */
-    static doAsync(actions: ChainedActions): ChainedControl;
+    static doAsync(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, waiting for any one action to complete
      * @chainable
      */
-    static any(actions: ChainedActions): ChainedControl;
+    static any(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, waiting for all actions to complete
      * @chainable
      */
-    static all(actions: ChainedActions): ChainedControl;
+    static all(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, do not wait for all actions to complete
      * @chainable
      */
-    static allAsync(actions: ChainedActions): ChainedControl;
+    static allAsync(actions: ActionStatements): ChainedControl;
     /**
      * Execute actions multiple times
      * @chainable
      */
-    static repeat(times: number, actions: ChainedActions): ChainedControl;
+    static repeat(times: number, actions: ActionStatements): ChainedControl;
     /**
      * Sleep for a duration
      * @chainable
@@ -42,32 +42,32 @@ export declare class Control extends Actionable {
      * Execute actions in order, waiting for each action to complete
      * @chainable
      */
-    do(actions: ChainedActions): ChainedControl;
+    do(actions: ActionStatements): ChainedControl;
     /**
      * Execute actions in order, do not wait for this action to complete
      * @chainable
      */
-    doAsync(actions: ChainedActions): ChainedControl;
+    doAsync(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, waiting for any one action to complete
      * @chainable
      */
-    any(actions: ChainedActions): ChainedControl;
+    any(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, waiting for all actions to complete
      * @chainable
      */
-    all(actions: ChainedActions): ChainedControl;
+    all(actions: ActionStatements): ChainedControl;
     /**
      * Execute all actions at the same time, do not wait for all actions to complete
      * @chainable
      */
-    allAsync(actions: ChainedActions): ChainedControl;
+    allAsync(actions: ActionStatements): ChainedControl;
     /**
      * Execute actions multiple times
      * @chainable
      */
-    repeat(times: number, actions: ChainedActions): ChainedControl;
+    repeat(times: number, actions: ActionStatements): ChainedControl;
     /**
      * Sleep for a duration
      * @chainable

package/dist/game/nlcore/elements/displayable/image.d.ts

@@ -37,6 +37,11 @@ export interface IImageUserConfig<Tag extends TagGroupDefinition | null = TagGro
      * layer of the image
      */
     layer?: Layer;
+    /**
+     * Darkness of the image, between 0 and 1
+     * @default 0
+     */
+    darkness?: number;
 }
 export type TagGroupDefinition = string[][];
 export type TagSrcResolver<T extends TagGroupDefinition> = (...tags: SelectElementFromEach<T>) => string;
@@ -59,6 +64,12 @@ export declare class Image<Tags extends TagGroupDefinition | null = TagGroupDefi
      */
     char(src: ImageSrc | Color, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
     char(tags: SelectElementFromEach<Tags> | FlexibleTuple<SelectElementFromEach<Tags>>, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
+    /**
+     * Set the darkness of the image
+     * @param darkness - The darkness of the image, between 0 and 1
+     * @chainable
+     */
+    darken(darkness: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Image, Chained<LogicAction.Actions>>;
     /**
      * Add a wearable to the image
      * @param children - Wearable image or images

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

@@ -1,9 +1,11 @@
 import { CommonDisplayableConfig } from "../types";
+import { LogicAction } from "../action/logicAction";
 import { TransformDefinitions } from "../elements/transform/type";
 import { Displayable } from "../elements/displayable/displayable";
 import { EventfulDisplayable } from "../../player/elements/displayable/type";
 import { Image } from "../elements/displayable/image";
 import { Text } from "../elements/displayable/text";
+import { Chained, Proxied } from "../action/chain";
 export interface ILayerUserConfig extends CommonDisplayableConfig {
     /**
      * The z-index of the layer, higher z-index will be rendered on top of the lower z-index, allows negative values.
@@ -20,4 +22,12 @@ export declare class Layer extends Displayable<LayerDataRaw, Layer, TransformDef
      * Same as {@link Displayable.useLayer}
      */
     include(elements: (Image | Text)[] | Image | Text): this;
+    /**
+     * Set the z-index of the layer
+     *
+     * @chainable
+     * @param zIndex - The z-index of the layer
+     * @returns The layer itself
+     */
+    setZIndex(zIndex: number): Proxied<Layer, Chained<LogicAction.Actions>>;
 }

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

@@ -3,9 +3,10 @@ import { Actionable } from "../action/actionable";
 import { Chained, Proxied } from "../action/chain";
 import { Sentence, SentencePrompt } from "../elements/character/sentence";
 import Actions = LogicAction.Actions;
+import { ActionStatements } from "./type";
 export type MenuConfig = {};
 export type MenuChoice = {
-    action: ChainedActions;
+    action: ActionStatements;
     prompt: SentencePrompt | Sentence;
 };
 export type Choice = {
@@ -22,12 +23,13 @@ export declare class Menu extends Actionable<any, Menu> {
      * @param prompt - The prompt to display to the player
      * @returns A new menu
      */
-    static prompt(prompt: SentencePrompt | Sentence, config?: MenuConfig): Menu;
-    static choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
+    static prompt(prompt: SentencePrompt | Sentence | null | undefined, config?: MenuConfig): Menu;
+    static choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ActionStatements): Proxied<Menu, Chained<LogicAction.Actions>>;
     constructor(prompt: SentencePrompt, config?: MenuConfig);
     constructor(prompt: Sentence, config?: MenuConfig);
     constructor(prompt: SentencePrompt | Sentence, config: MenuConfig);
     constructor(prompt: null, config?: MenuConfig);
+    constructor(prompt: SentencePrompt | Sentence | null, config: MenuConfig);
     /**
      * Add a choice to the menu
      * @example
@@ -37,7 +39,7 @@ export declare class Menu extends Actionable<any, Menu> {
      * @chainable
      */
     choose(choice: MenuChoice): Proxied<Menu, Chained<LogicAction.Actions>>;
-    choose(prompt: Sentence, action: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
-    choose(prompt: SentencePrompt, action: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
-    choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
+    choose(prompt: Sentence, action: ActionStatements): Proxied<Menu, Chained<LogicAction.Actions>>;
+    choose(prompt: SentencePrompt, action: ActionStatements): Proxied<Menu, Chained<LogicAction.Actions>>;
+    choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ActionStatements): Proxied<Menu, Chained<LogicAction.Actions>>;
 }

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

@@ -3,7 +3,7 @@ import { Color, ImageSrc } from "../types";
 import { LogicAction } from "../action/logicAction";
 import { Sound, VoiceIdMap, VoiceSrcGenerator } from "../elements/sound";
 import { Image } from "../elements/displayable/image";
-import { Persistent } from "../common/core";
+import { ActionStatements, Persistent } from "../common/core";
 import { Chained, Proxied } from "../action/chain";
 import { ImageTransition } from "../elements/transition/transitions/image/imageTransition";
 import { Layer } from "../elements/layer";
@@ -66,8 +66,8 @@ export declare class Scene extends Constructable<LogicAction.Actions, Scene> {
     /**
      * Add actions to the scene
      */
-    action(actions: (ChainableAction | ChainableAction[])[]): this;
-    action(actions: ((scene: Scene) => ChainableAction[]) | (() => ChainableAction[])): this;
+    action(actions: ActionStatements): this;
+    action(actions: ((scene: Scene) => ActionStatements) | (() => ActionStatements)): this;
     /**
      * Manually register image sources
      */

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

@@ -2,6 +2,11 @@ import { Actionable } from "../action/actionable";
 import { LogicAction } from "../game";
 import { Chained, Proxied } from "../action/chain";
 type ChainedSound = Proxied<Sound, Chained<LogicAction.Actions>>;
+export declare enum SoundType {
+    Voice = "voice",
+    Bgm = "bgm",
+    Sound = "sound"
+}
 export type VoiceIdMap = Record<string | number, string | Sound>;
 export type VoiceSrcGenerator = (id: string | number) => string | Sound;
 export interface ISoundUserConfig {
@@ -36,12 +41,21 @@ export interface ISoundUserConfig {
      * @default 0
      */
     seek: number;
+    /**
+     * The type of the sound
+     * @default SoundType.Sound
+     */
+    type: SoundType;
 }
 export declare class Sound extends Actionable<SoundDataRaw, Sound> {
+    static voice(arg0: Partial<ISoundUserConfig> | string): Sound;
+    static bgm(arg0: Partial<ISoundUserConfig> | string): Sound;
+    static sound(arg0: Partial<ISoundUserConfig> | string): Sound;
     constructor(config?: Partial<ISoundUserConfig>);
     constructor(src?: string);
+    constructor(arg0: Partial<ISoundUserConfig> | string);
     /**
-     * Start playing the sound
+     * Start playing the sound and **wait for it to finish**
      *
      * This action will be resolved when the sound reaches the end
      * @chainable

package/dist/game/nlcore/elements/transform/position.d.ts

@@ -50,7 +50,7 @@ export declare class CommonPosition implements IPosition {
 export declare class Coord2D implements IPosition {
     static isCoord2DPosition(arg: any): arg is Coord2D;
     static fromCommonPosition(position: CommonPosition): Coord2D;
-    static fromAlignPosition(position: AlignPosition): Coord2D;
+    static fromAlignPosition(position: Partial<AlignPosition>): Coord2D;
     static merge(a: Coord2D, b: Coord2D): Coord2D;
     readonly x: UnknownAble<Coord2DPosition["x"]>;
     readonly y: UnknownAble<Coord2DPosition["y"]>;
@@ -72,6 +72,7 @@ export declare class Coord2D implements IPosition {
         yoffset?: UnknownAble<number>;
     });
     constructor(x: UnknownAble<Coord2DPosition["x"]>, y: UnknownAble<Coord2DPosition["y"]>);
+    check(): void;
     toCSS(): D2Position<Coord2DPosition["x"], Coord2DPosition["y"]>;
 }
 export declare class Align implements IPosition {
@@ -96,6 +97,7 @@ export declare class Align implements IPosition {
         xoffset?: UnknownAble<number>;
         yoffset?: UnknownAble<number>;
     });
+    check(): void;
     toCSS(): D2Position;
 }
 export {};

package/dist/game/nlcore/elements/transition/transitions/image/darkness.d.ts

@@ -0,0 +1,20 @@
+import { TransitionAnimationType, TransitionTask } from "../../../../elements/transition/type";
+import { TransformDefinitions } from "../../../../elements/transform/type";
+import { ImageTransition } from "../../../../elements/transition/transitions/image/imageTransition";
+type AnimationType = [TransitionAnimationType.Number];
+export declare class Darkness extends ImageTransition<AnimationType> {
+    private prevDarkness;
+    private targetDarkness;
+    private duration;
+    private easing?;
+    /**
+     * Darken the original image and fade in the target image at the same time.
+     * @param darkness darkness of the image, between 0 and 1
+     * @param duration duration in milliseconds
+     * @param easing easing definition or existing easing name
+     */
+    constructor(prevDarkness: number, targetDarkness: number, duration: number, easing?: TransformDefinitions.EasingDefinition | undefined);
+    createTask(): TransitionTask<HTMLImageElement, AnimationType>;
+    copy(): Darkness;
+}
+export {};

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

@@ -12,4 +12,5 @@ export type FadeOptions = {
     duration: number;
 };
 export type ChainedActions = (Proxied<LogicAction.GameElement, Chained<LogicAction.Actions>> | LogicAction.Actions)[];
+export type ActionStatements = ChainedActions | string[];
 export type { TransitionAnimationType, TransitionTask, };

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

@@ -102,6 +102,10 @@ export declare class LiveGame {
     newGame(): this & {
         gameState: GameState;
     };
+    waitForRouterExit(): {
+        promise: Promise<void>;
+        cancel: VoidFunction;
+    };
     /**
      * Request full screen on Chrome/Safari/Firefox/IE/Edge/Opera, the player element will be full screen
      *
@@ -120,5 +124,15 @@ export declare class LiveGame {
      * Listen to the events of the player element
      */
     onPlayerEvent<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): LiveGameEventToken;
+    /**
+     * Listen to the events of the window
+     */
+    onWindowEvent<K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions): LiveGameEventToken;
+    /**
+     * Reset the game state
+     *
+     * **Note**: calling this method will lose the current game state
+     */
+    reset(): void;
     getGameState(): GameState | undefined;
 }

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

@@ -29,8 +29,34 @@ export type GamePreference = {
      * Dialog speed will apply to:
      * - The text speed
      * - The auto-forward delay
+     * @default 1.0
      */
     gameSpeed: number;
+    /**
+     * The speed of the text effects in characters per second.
+     * @default 10
+     */
+    cps: number;
+    /**
+     * The volume of the voice
+     * @default 1
+     */
+    voiceVolume: number;
+    /**
+     * The volume of the background music
+     * @default 1
+     */
+    bgmVolume: number;
+    /**
+     * The volume of the sound effects
+     * @default 1
+     */
+    soundVolume: number;
+    /**
+     * The volume of the global audio
+     * @default 1
+     */
+    globalVolume: number;
 };
 export type GameHooks = {
     /**

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

@@ -77,6 +77,14 @@ export type GameConfig = {
      * @default 100
      */
     skipInterval: number;
+    /**
+     * If true, the game will listen to the window events instead of the player element
+     *
+     * Using this will allow the game to listen to the keyboard events even when the player is not focused
+     * Resulting in a better user experience on skipping actions
+     * @default false
+     */
+    useWindowListener: boolean;
     /**
      * The debounced interval in milliseconds for updating the aspect ratio
      *
@@ -155,11 +163,6 @@ export type GameConfig = {
      * @default [" "]
      */
     nextKey: React.KeyboardEvent["key"][];
-    /**
-     * The speed of the text effects in characters per second.
-     * @default 10
-     */
-    cps: number;
     /**
      * If true, the game will scale the dialog to fit the screen
      *

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

@@ -64,3 +64,4 @@ export type NamedColor = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" |
 export interface ActionSearchOptions {
     allowFutureScene?: boolean;
 }
+export type { SavedGame } from "./gameTypes";

package/dist/game/player/elements/image/AspectScaleImage.d.ts

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

package/dist/game/player/elements/player/PreferenceUpdateAnnouncer.d.ts

@@ -0,0 +1,4 @@
+import { GameState } from "../../../../game/nlcore/common/game";
+export default function PreferenceUpdateAnnouncer({ gameState }: Readonly<{
+    gameState: GameState;
+}>): null;

package/dist/game/player/elements/player/RenderEventAnnoucer.d.ts

@@ -0,0 +1,4 @@
+import { GameState } from "../../gameState";
+export declare function RenderEventAnnoucer({ gameState }: {
+    gameState: GameState;
+}): null;

package/dist/game/player/elements/say/UIDialog.d.ts

@@ -9,6 +9,7 @@ type DialogEvents = {
     "event:dialog.complete": [];
     "event:dialog.forceSkip": [];
     "event:dialog.onFlush": [];
+    "event:dialog.simulateClick": [];
 };
 type DialogStateConfig = {
     useTypeEffect: boolean;
@@ -22,6 +23,7 @@ export declare class DialogState {
         complete: "event:dialog.complete";
         forceSkip: "event:dialog.forceSkip";
         onFlush: "event:dialog.onFlush";
+        simulateClick: "event:dialog.simulateClick";
     };
     readonly config: Readonly<DialogStateConfig>;
     readonly events: EventDispatcher<DialogEvents>;