narraleaf-react 0.4.4 → 0.6.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/action.d.ts

@@ -1,24 +1,29 @@
-import { 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";
-export declare class Action<ContentNodeType = any, Callee = LogicAction.GameElement, Type extends string = any> {
-    static ActionTypes: {
-        action: string;
-    };
-    callee: Callee;
-    type: Type;
-    contentNode: ContentNode<ContentNodeType>;
-    _id: string;
-    readonly __stack: string;
-    constructor(callee: Callee, type: Type, contentNode: ContentNode<ContentNodeType>);
-    executeAction(_state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
-    getId(): string;
-    setId(id: string): void;
-    setContent(content: ContentNodeType): this;
-    setContentNode(contentNode: ContentNode<ContentNodeType>): this;
-    getFutureActions(_story: Story, _options: ActionSearchOptions): LogicAction.Actions[];
-}
+import { 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 { StackModel } from "./stackModel";
+export type ActionExecutionInjection = {
+    stackModel: StackModel;
+};
+export type ExecutedActionResult = CalledActionResult | Awaitable<CalledActionResult, any> | (CalledActionResult | Awaitable<CalledActionResult, any>)[] | null;
+export declare class Action<ContentNodeType = any, Callee = LogicAction.GameElement, Type extends string = any> {
+    static ActionTypes: {
+        action: string;
+    };
+    callee: Callee;
+    type: Type;
+    contentNode: ContentNode<ContentNodeType>;
+    _id: string;
+    readonly __stack: string;
+    constructor(callee: Callee, type: Type, contentNode: ContentNode<ContentNodeType>);
+    executeAction(_state: GameState, _injection: ActionExecutionInjection): ExecutedActionResult;
+    getId(): string;
+    setId(id: string): void;
+    setContent(content: ContentNodeType): this;
+    setContentNode(contentNode: ContentNode<ContentNodeType>): this;
+    getFutureActions(_story: Story, _options: ActionSearchOptions): LogicAction.Actions[];
+}

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

@@ -1,37 +1,48 @@
-import { Timeline } from "../../../game/player/Tasks";
-import { Action } from "./action";
-import { LiveGameEventToken } from "../types";
-import { LogicAction } from "../game";
-export type ActionHistory<T extends Array<unknown> = any> = {
-    action: Action;
-    timeline?: Timeline;
-    args: T;
-    id: string;
-    undo?: (...args: T) => void;
-};
-export declare class ActionHistoryManager {
-    private history;
-    private readonly maxHistorySize;
-    private hooks;
-    constructor(maxHistorySize?: number);
-    /**
-     * Push an action to the history
-     */
-    push<T extends Array<any> = Array<any>>(action: Action, onUndo?: (...args: T) => void, args?: T, timeline?: Timeline): {
-        id: string;
-    };
-    /**
-     * Undo all actions until the given id
-     *
-     * If the given id is not found, nothing will happen
-     * @param id random id generated by push
-     */
-    undoUntil(id: string): LogicAction.Actions | null;
-    undo(): LogicAction.Actions | null;
-    onUndo(callback: (affected: ActionHistory<any>[]) => void): LiveGameEventToken;
-    offUndo(callback: (affected: ActionHistory<any>[]) => void): void;
-    getHistory(): ActionHistory<any>[];
-    onHistoryLimit(callback: (removed: ActionHistory<any>[]) => void): LiveGameEventToken;
-    offHistoryLimit(callback: (removed: ActionHistory<any>[]) => void): void;
-    reset(): void;
-}
+import { Timeline } from "../../../game/player/Tasks";
+import { Action } from "./action";
+import { LiveGameEventToken } from "../types";
+import { GameHistoryManager } from "./gameHistory";
+import { StackModel, StackModelRawData } from "./stackModel";
+import type { LiveGame } from "../game/liveGame";
+export type ActionHistory<T extends Array<unknown> = any> = {
+    action: Action;
+    timeline?: Timeline;
+    args: T;
+    id: string;
+    undo?: (...args: T) => void;
+    rootStackSnapshot: StackModelRawData;
+    stackModel: StackModel;
+};
+export type ActionHistoryPushOptions = {
+    timeline?: Timeline;
+    stackModel: StackModel;
+    action: Action;
+};
+export declare class ActionHistoryManager {
+    readonly liveGame: LiveGame;
+    private history;
+    private readonly maxHistorySize;
+    private hooks;
+    constructor(maxHistorySize: number | undefined, liveGame: LiveGame);
+    /**
+     * Push an action to the history
+     */
+    push<T extends Array<any> = Array<any>>(props: ActionHistoryPushOptions, onUndo?: (...args: T) => void, args?: T): {
+        id: string;
+    };
+    /**
+     * Undo all actions until the given id
+     *
+     * If the given id is not found, nothing will happen
+     * @param id random id generated by push
+     */
+    undoUntil(id: string): ActionHistory | null;
+    undo(gameHistory: GameHistoryManager): ActionHistory | null;
+    ableToUndo(gameHistory: GameHistoryManager): boolean;
+    onUndo(callback: (affected: ActionHistory<any>[]) => void): LiveGameEventToken;
+    offUndo(callback: (affected: ActionHistory<any>[]) => void): void;
+    getHistory(): ActionHistory<any>[];
+    onHistoryLimit(callback: (removed: ActionHistory<any>[]) => void): LiveGameEventToken;
+    offHistoryLimit(callback: (removed: ActionHistory<any>[]) => void): void;
+    reset(): void;
+}

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

@@ -1,140 +1,142 @@
-import { LogicAction } from "../action/logicAction";
-import type { Story } from "../elements/story";
-import type { ConditionData } from "../elements/condition";
-import { Color, ImageSrc } from "../types";
-import { 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 { Sound } from "../elements/sound";
-import type { Script } from "../elements/script";
-import { 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";
-export declare const DisplayableActionTypes: {
-    readonly action: "displayable:action";
-    readonly applyTransform: "displayable:applyTransform";
-    readonly applyTransition: "displayable:applyTransition";
-    readonly init: "displayable:init";
-};
-export type DisplayableActionContentType<TransitionType extends Transition = Transition> = {
-    [K in typeof DisplayableActionTypes[keyof typeof DisplayableActionTypes]]: K extends "displayable:applyTransform" ? [Transform] : K extends "displayable:applyTransition" ? [TransitionType, ((transition: TransitionType) => TransitionType)?] : K extends "displayable:init" ? [scene: Scene | null, layer: Layer | null, isElement?: boolean] : any;
-};
-export declare const CharacterActionTypes: {
-    readonly say: "character:say";
-    readonly action: "character:action";
-    readonly setName: "character:setName";
-};
-export type CharacterActionContentType = {
-    [K in typeof CharacterActionTypes[keyof typeof CharacterActionTypes]]: K extends "character:say" ? Sentence : K extends "character:action" ? any : K extends "character:setName" ? [string] : any;
-};
-export declare const SceneActionTypes: {
-    readonly action: "scene:action";
-    readonly init: "scene:init";
-    readonly exit: "scene:exit";
-    readonly jumpTo: "scene:jumpTo";
-    readonly setBackgroundMusic: "scene:setBackgroundMusic";
-    readonly preUnmount: "scene:preUnmount";
-    readonly transitionToScene: "scene:transitionToScene";
-};
-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;
-};
-export declare const StoryActionTypes: {
-    readonly action: "story:action";
-};
-export type StoryActionContentType = {
-    [K in typeof StoryActionTypes[keyof typeof StoryActionTypes]]: K extends "story:action" ? Story : any;
-};
-export declare const ImageActionTypes: {
-    readonly action: "image:action";
-    readonly setSrc: "image:setSrc";
-    readonly flush: "image:flush";
-    readonly initWearable: "image:initWearable";
-    readonly setAppearance: "image:setAppearance";
-};
-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;
-} & DisplayableActionContentType<ImageTransition>;
-export declare const ConditionActionTypes: {
-    readonly action: "condition:action";
-};
-export type ConditionActionContentType = {
-    [K in typeof ConditionActionTypes[keyof typeof ConditionActionTypes]]: K extends "condition:action" ? ConditionData : any;
-};
-export declare const ScriptActionTypes: {
-    readonly action: "script:action";
-};
-export type ScriptActionContentType = {
-    [K in typeof ScriptActionTypes[keyof typeof ScriptActionTypes]]: K extends "script:action" ? Script : any;
-};
-export declare const MenuActionTypes: {
-    readonly action: "menu:action";
-};
-export type MenuActionContentType = {
-    [K in typeof MenuActionTypes[keyof typeof MenuActionTypes]]: K extends "menu:action" ? MenuData : any;
-};
-export declare const SoundActionTypes: {
-    readonly action: "sound:action";
-    readonly play: "sound:play";
-    readonly stop: "sound:stop";
-    readonly setVolume: "sound:setVolume";
-    readonly setRate: "sound:setRate";
-    readonly pause: "sound:pause";
-    readonly resume: "sound:resume";
-};
-export type SoundActionContentType = {
-    [K in typeof SoundActionTypes[keyof typeof SoundActionTypes]]: K extends "sound:play" ? [FadeOptions] : K extends "sound:stop" ? [FadeOptions] : K extends "sound:setVolume" ? [volumn: number, duration: number] : K extends "sound:setRate" ? [number] : K extends "sound:pause" ? [FadeOptions] : K extends "sound:resume" ? [FadeOptions] : any;
-};
-export declare const ControlActionTypes: {
-    readonly action: "control:action";
-    readonly do: "control:do";
-    readonly doAsync: "control:doAsync";
-    readonly any: "control:any";
-    readonly all: "control:all";
-    readonly allAsync: "control:allAsync";
-    readonly repeat: "control:repeat";
-    readonly sleep: "control:sleep";
-};
-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:sleep" ? [LogicAction.Actions[], number | Awaitable<any> | Promise<any>] : any;
-};
-export declare const TextActionTypes: {
-    readonly action: "text:action";
-    readonly setText: "text:setText";
-    readonly setFontSize: "text:setFontSize";
-};
-export type TextActionContentType = {
-    [K in typeof TextActionTypes[keyof typeof TextActionTypes]]: K extends "text:setText" ? [string] : K extends "text:show" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:hide" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:applyTransform" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:init" ? [Scene?] : K extends "text:setFontSize" ? [number] : any;
-};
-export declare const PersistentActionTypes: {
-    readonly action: "persistent:action";
-    readonly set: "persistent:set";
-    readonly assign: "persistent:assign";
-};
-export type PersistentActionContentType = {
-    [K in typeof PersistentActionTypes[keyof typeof PersistentActionTypes]]: K extends "persistent:action" ? any : K extends "persistent:set" ? [string, unknown | ((value: unknown) => unknown)] : K extends "persistent:assign" ? [Partial<unknown>] : any;
-};
-export declare const LayerActionTypes: {
-    readonly action: "layer:action";
-};
-export type LayerActionContentType = {
-    [K in typeof LayerActionTypes[keyof typeof LayerActionTypes]]: K extends "layer:action" ? any : any;
-};
-export declare const VideoActionTypes: {
-    readonly action: "video:action";
-    readonly show: "video:show";
-    readonly hide: "video:hide";
-    readonly play: "video:play";
-    readonly pause: "video:pause";
-    readonly resume: "video:resume";
-    readonly stop: "video:stop";
-    readonly seek: "video:seek";
-};
-export type VideoActionContentType = {
-    [K in typeof VideoActionTypes[keyof typeof VideoActionTypes]]: K extends "video:action" ? any : K extends "video:show" | "video:hide" | "video:play" | "video:pause" | "video:stop" ? [] : K extends "video:seek" ? [number] : any;
-};
+import { LogicAction } from "../action/logicAction";
+import type { Story } from "../elements/story";
+import type { ConditionData } from "../elements/condition";
+import { Color, ImageSrc } from "../types";
+import { 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 { Sound } from "../elements/sound";
+import type { Script } from "../elements/script";
+import { 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";
+export declare const DisplayableActionTypes: {
+    readonly action: "displayable:action";
+    readonly applyTransform: "displayable:applyTransform";
+    readonly applyTransition: "displayable:applyTransition";
+    readonly init: "displayable:init";
+};
+export type DisplayableActionContentType<TransitionType extends Transition = Transition> = {
+    [K in typeof DisplayableActionTypes[keyof typeof DisplayableActionTypes]]: K extends "displayable:applyTransform" ? [Transform] : K extends "displayable:applyTransition" ? [TransitionType, ((transition: TransitionType) => TransitionType)?] : K extends "displayable:init" ? [scene: Scene | null, layer: Layer | null, isElement?: boolean] : any;
+};
+export declare const CharacterActionTypes: {
+    readonly say: "character:say";
+    readonly action: "character:action";
+    readonly setName: "character:setName";
+};
+export type CharacterActionContentType = {
+    [K in typeof CharacterActionTypes[keyof typeof CharacterActionTypes]]: K extends "character:say" ? Sentence : K extends "character:action" ? any : K extends "character:setName" ? [string] : any;
+};
+export declare const SceneActionTypes: {
+    readonly action: "scene:action";
+    readonly init: "scene:init";
+    readonly exit: "scene:exit";
+    readonly jumpTo: "scene:jumpTo";
+    readonly setBackgroundMusic: "scene:setBackgroundMusic";
+    readonly preUnmount: "scene:preUnmount";
+    readonly transitionToScene: "scene:transitionToScene";
+};
+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;
+};
+export declare const StoryActionTypes: {
+    readonly action: "story:action";
+};
+export type StoryActionContentType = {
+    [K in typeof StoryActionTypes[keyof typeof StoryActionTypes]]: K extends "story:action" ? Story : any;
+};
+export declare const ImageActionTypes: {
+    readonly action: "image:action";
+    readonly setSrc: "image:setSrc";
+    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] : K extends "image:setDarkness" ? [darkness: number, duration?: number, easing?: TransformDefinitions.EasingDefinition] : any;
+} & DisplayableActionContentType<ImageTransition>;
+export declare const ConditionActionTypes: {
+    readonly action: "condition:action";
+};
+export type ConditionActionContentType = {
+    [K in typeof ConditionActionTypes[keyof typeof ConditionActionTypes]]: K extends "condition:action" ? ConditionData : any;
+};
+export declare const ScriptActionTypes: {
+    readonly action: "script:action";
+};
+export type ScriptActionContentType = {
+    [K in typeof ScriptActionTypes[keyof typeof ScriptActionTypes]]: K extends "script:action" ? Script : any;
+};
+export declare const MenuActionTypes: {
+    readonly action: "menu:action";
+};
+export type MenuActionContentType = {
+    [K in typeof MenuActionTypes[keyof typeof MenuActionTypes]]: K extends "menu:action" ? MenuData : any;
+};
+export declare const SoundActionTypes: {
+    readonly action: "sound:action";
+    readonly play: "sound:play";
+    readonly stop: "sound:stop";
+    readonly setVolume: "sound:setVolume";
+    readonly setRate: "sound:setRate";
+    readonly pause: "sound:pause";
+    readonly resume: "sound:resume";
+};
+export type SoundActionContentType = {
+    [K in typeof SoundActionTypes[keyof typeof SoundActionTypes]]: K extends "sound:play" ? [FadeOptions] : K extends "sound:stop" ? [FadeOptions] : K extends "sound:setVolume" ? [volumn: number, duration: number] : K extends "sound:setRate" ? [number] : K extends "sound:pause" ? [FadeOptions] : K extends "sound:resume" ? [FadeOptions] : any;
+};
+export declare const ControlActionTypes: {
+    readonly action: "control:action";
+    readonly do: "control:do";
+    readonly doAsync: "control:doAsync";
+    readonly any: "control:any";
+    readonly all: "control:all";
+    readonly allAsync: "control:allAsync";
+    readonly repeat: "control:repeat";
+    readonly sleep: "control:sleep";
+};
+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:sleep" ? [LogicAction.Actions[], number | Awaitable<any> | Promise<any>] : any;
+};
+export declare const TextActionTypes: {
+    readonly action: "text:action";
+    readonly setText: "text:setText";
+    readonly setFontSize: "text:setFontSize";
+};
+export type TextActionContentType = {
+    [K in typeof TextActionTypes[keyof typeof TextActionTypes]]: K extends "text:setText" ? [string] : K extends "text:show" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:hide" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:applyTransform" ? [Transform<TransformDefinitions.TextTransformProps>] : K extends "text:init" ? [Scene?] : K extends "text:setFontSize" ? [number] : any;
+};
+export declare const PersistentActionTypes: {
+    readonly action: "persistent:action";
+    readonly set: "persistent:set";
+    readonly assign: "persistent:assign";
+};
+export type PersistentActionContentType = {
+    [K in typeof PersistentActionTypes[keyof typeof PersistentActionTypes]]: K extends "persistent:action" ? any : K extends "persistent:set" ? [string, unknown | ((value: unknown) => unknown)] : K extends "persistent:assign" ? [Partial<unknown>] : any;
+};
+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 : K extends "layer:setZIndex" ? [number] : any;
+};
+export declare const VideoActionTypes: {
+    readonly action: "video:action";
+    readonly show: "video:show";
+    readonly hide: "video:hide";
+    readonly play: "video:play";
+    readonly pause: "video:pause";
+    readonly resume: "video:resume";
+    readonly stop: "video:stop";
+    readonly seek: "video:seek";
+};
+export type VideoActionContentType = {
+    [K in typeof VideoActionTypes[keyof typeof VideoActionTypes]]: K extends "video:action" ? any : K extends "video:show" | "video:hide" | "video:play" | "video:pause" | "video:stop" ? [] : K extends "video:seek" ? [number] : any;
+};

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

@@ -1,5 +1,5 @@
-import { LogicAction } from "../action/logicAction";
-import { Chainable } from "../action/chain";
-export declare class Actionable<StateData extends Record<string, any> | null = Record<string, any>, Self extends Actionable = any> extends Chainable<LogicAction.Actions, Self> {
-    constructor();
-}
+import { LogicAction } from "../action/logicAction";
+import { Chainable } from "../action/chain";
+export declare class Actionable<StateData extends Record<string, any> | null = Record<string, any>, Self extends Actionable = any> extends Chainable<LogicAction.Actions, Self> {
+    constructor();
+}

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

@@ -1,17 +1,19 @@
-import { CharacterActionContentType, CharacterActionTypes } from "../../action/actionTypes";
-import type { Character } from "../../elements/character";
-import { GameState } from "../../../player/gameState";
-import type { CalledActionResult } from "../../gameTypes";
-import { Awaitable } from "../../../../util/data";
-import { Sentence } from "../../elements/character/sentence";
-import { TypedAction } from "../../action/actions";
-import { Sound } from "../../elements/sound";
-export declare class CharacterAction<T extends typeof CharacterActionTypes[keyof typeof CharacterActionTypes] = typeof CharacterActionTypes[keyof typeof CharacterActionTypes]> extends TypedAction<CharacterActionContentType, T, Character> {
-    static ActionTypes: {
-        readonly say: "character:say";
-        readonly action: "character:action";
-        readonly setName: "character:setName";
-    };
-    static getVoice(state: GameState, sentence: Sentence): Sound | null;
-    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
-}
+import { CharacterActionContentType, CharacterActionTypes } from "../../action/actionTypes";
+import type { Character } from "../../elements/character";
+import { GameState } from "../../../player/gameState";
+import { Sentence } from "../../elements/character/sentence";
+import { TypedAction } from "../../action/actions";
+import { Sound } from "../../elements/sound";
+import { ActionExecutionInjection, ExecutedActionResult } from "../../action/action";
+import { LogicAction } from "../../action/logicAction";
+import { Story } from "../../elements/story";
+export declare class CharacterAction<T extends typeof CharacterActionTypes[keyof typeof CharacterActionTypes] = typeof CharacterActionTypes[keyof typeof CharacterActionTypes]> extends TypedAction<CharacterActionContentType, T, Character> {
+    static ActionTypes: {
+        readonly say: "character:say";
+        readonly action: "character:action";
+        readonly setName: "character:setName";
+    };
+    static getVoice(state: GameState, sentence: Sentence): Sound | null;
+    executeAction(gameState: GameState, injection: ActionExecutionInjection): ExecutedActionResult;
+    stringify(_story: Story, _seen: Set<LogicAction.Actions>, _strict: boolean): string;
+}

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

@@ -1,17 +1,26 @@
-import { ConditionActionContentType, ConditionActionTypes } from "../../action/actionTypes";
-import type { Condition } from "../../elements/condition";
-import { GameState } from "../../../player/gameState";
-import { LogicAction } from "../../action/logicAction";
-import { TypedAction } from "../../action/actions";
-import { Story } from "../../elements/story";
-import { ActionSearchOptions } from "../../types";
-export declare class ConditionAction<T extends typeof ConditionActionTypes[keyof typeof ConditionActionTypes] = typeof ConditionActionTypes[keyof typeof ConditionActionTypes]> extends TypedAction<ConditionActionContentType, T, Condition> {
-    static ActionTypes: {
-        readonly action: "condition:action";
-    };
-    executeAction(gameState: GameState): {
-        type: any;
-        node: import("../tree/actionTree").RenderableNode | null;
-    };
-    getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
-}
+import { ConditionActionContentType, ConditionActionTypes } from "../../action/actionTypes";
+import type { Condition } from "../../elements/condition";
+import { GameState } from "../../../player/gameState";
+import { LogicAction } from "../../action/logicAction";
+import { TypedAction } from "../../action/actions";
+import { Story } from "../../elements/story";
+import { ActionSearchOptions } from "../../types";
+export declare class ConditionAction<T extends typeof ConditionActionTypes[keyof typeof ConditionActionTypes] = typeof ConditionActionTypes[keyof typeof ConditionActionTypes]> extends TypedAction<ConditionActionContentType, T, Condition> {
+    static ActionTypes: {
+        readonly action: "condition:action";
+    };
+    executeAction(gameState: GameState): ({
+        type: T;
+        node: import("../../action/tree/actionTree").RenderableNode | null;
+        wait?: undefined;
+    } | {
+        type: T;
+        node: null;
+        wait: {
+            type: "all";
+            stackModels: import("../stackModel").StackModel[];
+        };
+    })[];
+    getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
+    stringify(story: Story, seen: Set<LogicAction.Actions>, strict: boolean): string;
+}