narraleaf-react 0.3.1-alpha.1 → 0.4.0-beta.3

package/README.md

@@ -26,50 +26,50 @@ 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} from "narraleaf-react";
+import {Character, Menu, Scene, Word, c, b} from "narraleaf-react";
 ```
 
 ```typescript
 const scene1 = new Scene("scene1_hello_world", {
-    background: "/background/scene1_hello_world.jpg",
+  background: "/background/scene1_hello_world.jpg",
 });
 
 const johnSmith = new Character("John Smith");
 const johnDoe = 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 NarraLeaf story.")
-        .say`Start editing ${Word.color("src/story.js", "#0000ff")} 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!"),
+  /**
+   * 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!
-     */
-    new Menu("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.")
-        ])
-        .choose("No, I'm going to check the documentation", [
-            johnSmith.say("Sure! Take your time!")
-        ])
+  /**
+   * 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!
+   */
+  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.")
+    ])
+    .choose("No, I'm going to check the documentation", [
+      johnSmith.say("Sure! Take your time!")
+    ])
 ]);
 ```
 

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

@@ -0,0 +1,37 @@
+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;
+}

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

@@ -35,7 +35,6 @@ export type CharacterActionContentType = {
 };
 export declare const SceneActionTypes: {
     readonly action: "scene:action";
-    readonly sleep: "scene:sleep";
     readonly init: "scene:init";
     readonly exit: "scene:exit";
     readonly jumpTo: "scene:jumpTo";
@@ -44,7 +43,7 @@ export declare const SceneActionTypes: {
     readonly transitionToScene: "scene:transitionToScene";
 };
 export type SceneActionContentType = {
-    [K in typeof SceneActionTypes[keyof typeof SceneActionTypes]]: K extends typeof SceneActionTypes["action"] ? Scene : K extends typeof SceneActionTypes["sleep"] ? number | Promise<any> | Awaitable<any, any> : 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] : any;
 };
 export declare const StoryActionTypes: {
     readonly action: "story:action";
@@ -116,9 +115,10 @@ export type TextActionContentType = {
 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)] : any;
+    [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";
@@ -126,3 +126,16 @@ export declare const LayerActionTypes: {
 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;
+};

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

@@ -13,5 +13,5 @@ export declare class CharacterAction<T extends typeof CharacterActionTypes[keyof
         readonly setName: "character:setName";
     };
     static getVoice(state: GameState, sentence: Sentence): Sound | null;
-    executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
+    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
 }

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

@@ -4,10 +4,10 @@ import { GameState } from "../../../player/gameState";
 import { LogicAction } from "../../action/logicAction";
 import { Awaitable } from "../../../../util/data";
 import type { CalledActionResult } from "../../gameTypes";
-import { ContentNode } from "../../action/tree/actionTree";
 import { TypedAction } from "../../action/actions";
 import { Story } from "../../elements/story";
 import { ActionSearchOptions } from "../../types";
+import { Timeline } from "../../../player/Tasks";
 export declare class ControlAction<T extends typeof ControlActionTypes[keyof typeof ControlActionTypes] = typeof ControlActionTypes[keyof typeof ControlActionTypes]> extends TypedAction<ControlActionContentType, T, Control> {
     static ActionTypes: {
         readonly action: "control:action";
@@ -20,15 +20,19 @@ export declare class ControlAction<T extends typeof ControlActionTypes[keyof typ
         readonly sleep: "control:sleep";
     };
     /**
-     * Execute all actions in the content node
-     * will wait for awaitable actions to resolve
+     * Perform an action and all its children. Due to bidirectional bubbling, the Awaitable interrupt returned by the function affects the children who're executing.
+     *
+     * At the same time, the child interrupt will bubble up to the Awaitable returned by this function and interrupt the execution of the Timeline.
+     * This is because all later results of this function depend on the previous result, so it isn't possible to silently ignore interrupted sub operations.
+     *
+     * @template T The type of the result returned by the onResolved callback.
+     * @param {GameState} gameState - The current game state.
+     * @param {LogicAction.Actions} action - The action to be executed.
+     * @param {function(CalledActionResult): T} onResolved - A callback function that processes the result of the action. The awaitable will be resolved to the value returned by this callback.
+     * @returns {[Awaitable<T>, Timeline]} A tuple containing the Awaitable and the Timeline.
      */
-    executeAllActions(state: GameState, action: LogicAction.Actions): Promise<void>;
-    executeSingleAction(state: GameState, action: LogicAction.Actions): Promise<ContentNode | null>;
-    execute(state: GameState, awaitable: Awaitable<any, any>, content: LogicAction.Actions[]): {
-        type: any;
-        node: ContentNode<any> | null;
-    } | Awaitable<CalledActionResult<any>, any> | Awaitable<any, any>;
-    executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, CalledActionResult>;
+    executeActionSeries<T>(gameState: GameState, action: LogicAction.Actions, onResolved: (result: CalledActionResult) => T): [awaitable: Awaitable<T>, timeline: Timeline];
+    executeSingleAction(gameState: GameState, action: LogicAction.Actions): Awaitable<CalledActionResult> | LogicAction.Actions | null;
+    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, CalledActionResult>;
     getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
 }

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

@@ -7,6 +7,7 @@ export declare class PersistentAction<T extends Values<typeof PersistentActionTy
     static ActionTypes: {
         readonly action: "persistent:action";
         readonly set: "persistent:set";
+        readonly assign: "persistent:assign";
     };
     executeAction(gameState: GameState): import("../../gameTypes").CalledActionResult<any> | import("../../../../util/data").Awaitable<import("../../gameTypes").CalledActionResult<any>, any>;
 }

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

@@ -1,18 +1,25 @@
 import { SceneActionContentType, SceneActionTypes } from "../../action/actionTypes";
-import type { Scene } from "../../elements/scene";
-import { GameState } from "../../../player/gameState";
+import type { Scene, SceneDataRaw } from "../../elements/scene";
+import { GameState, PlayerStateElementSnapshot } from "../../../player/gameState";
 import { Awaitable } from "../../../../util/data";
 import type { CalledActionResult } from "../../gameTypes";
+import { ContentNode } from "../../action/tree/actionTree";
 import { LogicAction } from "../../action/logicAction";
 import { TypedAction } from "../../action/actions";
 import { Story } from "../../elements/story";
 import { ImageTransition } from "../../elements/transition/transitions/image/imageTransition";
 import { ActionSearchOptions } from "../../types";
 import { ExposedState, ExposedStateType } from "../../../player/type";
+import { ImageDataRaw } from "../../elements/displayable/image";
+type SceneSnapshot = {
+    state: SceneDataRaw | null;
+    local: Record<string, any>;
+    element: PlayerStateElementSnapshot;
+    background: ImageDataRaw | null;
+};
 export declare class SceneAction<T extends typeof SceneActionTypes[keyof typeof SceneActionTypes] = typeof SceneActionTypes[keyof typeof SceneActionTypes]> extends TypedAction<SceneActionContentType, T, Scene> {
     static ActionTypes: {
         readonly action: "scene:action";
-        readonly sleep: "scene:sleep";
         readonly init: "scene:init";
         readonly exit: "scene:exit";
         readonly jumpTo: "scene:jumpTo";
@@ -20,14 +27,18 @@ export declare class SceneAction<T extends typeof SceneActionTypes[keyof typeof
         readonly preUnmount: "scene:preUnmount";
         readonly transitionToScene: "scene:transitionToScene";
     };
-    static handleSceneInit(sceneAction: SceneAction<typeof SceneActionTypes["init"]>, state: GameState, awaitable: Awaitable<CalledActionResult, any>): Awaitable<CalledActionResult<any>, any> | {
-        type: "scene:init";
-        node: import("../../action/tree/actionTree").RenderableNode | null;
-    };
+    static handleSceneInit(scene: Scene, next: CalledActionResult, state: GameState, awaitable: Awaitable<CalledActionResult, any>): {
+        type: any;
+        node: ContentNode<any> | null;
+    } | Awaitable<CalledActionResult<any>, any>;
     static initBackgroundMusic(scene: Scene, exposed: ExposedState[ExposedStateType.scene]): void;
-    applyTransition(state: GameState, transition: ImageTransition): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
-    executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
+    static createSceneSnapshot(scene: Scene, state: GameState): SceneSnapshot;
+    static restoreSceneSnapshot(snapshot: SceneSnapshot, state: GameState): void;
+    applyTransition(gameState: GameState, transition: ImageTransition): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
+    exit(state: GameState): void;
+    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
     getFutureActions(story: Story, searchOptions?: ActionSearchOptions): LogicAction.Actions[];
     _sceneNotFoundError(sceneId: string): Error;
     getSceneName(scene: Scene | string): string;
 }
+export {};

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

@@ -0,0 +1,22 @@
+import { VideoActionContentType, VideoActionTypes } from "../../action/actionTypes";
+import { TypedAction } from "../../action/actions";
+import { Video } from "../../elements/video";
+import { GameState } from "../../../player/gameState";
+import { Awaitable, Values } from "../../../../util/data";
+import type { CalledActionResult } from "../../gameTypes";
+export declare class VideoAction<T extends Values<typeof VideoActionTypes> = Values<typeof VideoActionTypes>> extends TypedAction<VideoActionContentType, T, Video> {
+    static ActionTypes: {
+        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";
+    };
+    executeAction(gameState: GameState): Awaitable<CalledActionResult>;
+    private changeStateBase;
+    private changeState;
+    private changeStateAsync;
+}

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

@@ -0,0 +1,28 @@
+import { Action } from "./action";
+import { ActionHistoryManager } from "./actionHistory";
+type GameHistoryAction = {
+    token: string;
+    action: Action;
+};
+type GameElementHistory = {
+    type: "say";
+    text: string;
+    voice: string | null;
+} | {
+    type: "menu";
+    text: string;
+    selected: string;
+};
+export type GameHistory = GameHistoryAction & {
+    element: GameElementHistory;
+};
+export declare class GameHistoryManager {
+    private history;
+    private actionHistoryMgr;
+    constructor(actionHistoryMgr: ActionHistoryManager);
+    push(action: GameHistory): this;
+    getHistory(): GameHistory[];
+    reset(): void;
+    private crossFilter;
+}
+export {};

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

@@ -9,7 +9,7 @@ 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 } from "../action/actionTypes";
+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";
@@ -30,11 +30,13 @@ 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";
 export declare namespace LogicAction {
     type DisplayableElements = Text | Image | Layer | AbstractDisplayable<any, any>;
     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;
-    type Actions = TypedAction | CharacterAction | ConditionAction | ImageAction | SceneAction | ScriptAction | StoryAction | MenuAction | SoundAction | ControlAction | TextAction | DisplayableAction | PersistentAction | ServiceAction | LayerAction;
-    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>;
-    type ActionContents = CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType;
+    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 ActionContents = CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType & VideoActionContentType;
 }

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

@@ -15,4 +15,5 @@ import { Pause } from "../elements/character/pause";
 import { Persistent } from "../elements/persistent";
 import { Service } from "../elements/service";
 import { Layer } from "../elements/layer";
-export { Character, Condition, Control, Image, Lambda, Menu, Scene, Script, Sentence, Sound, Story, Transform, Word, Text, Pause, Persistent, Service, 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, };

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

@@ -2,4 +2,6 @@ import { Game } from "../game";
 import { GameState } from "../../player/gameState";
 import { Storable, Namespace } from "../elements/persistent/storable";
 import { LiveGame } from "../game/liveGame";
+import type { SavedGame } from "../gameTypes";
 export { LiveGame, GameState, Game, Storable, Namespace, };
+export type { SavedGame, };

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

@@ -1,5 +1,8 @@
-import { TransformDefinitions } from "../elements/transform/type";
-import { Origins } from "../elements/story";
 import { ServiceHandlerCtx } from "../elements/service";
+import { Origins } from "../elements/story";
+import { TransformDefinitions } from "../elements/transform/type";
+import { IGamePluginRegistry } from "../game/plugin/plugin";
+import { LiveGameEventToken } from "../types";
+import { GameHistory } from "../action/gameHistory";
 export * from "../elements/type";
-export type { TransformDefinitions, Origins, ServiceHandlerCtx, };
+export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions };

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

@@ -1,16 +1,24 @@
 import { Sound } from "../../elements/sound";
 import type { Character } from "../../elements/character";
+import { Word } from "../../elements/character/word";
 import { Color, Font } from "../../types";
+import type { ScriptCtx } from "../../elements/script";
+import { Pausing } from "../../elements/character/pause";
 export type SentenceConfig = {
     pause?: boolean | number;
     voice: Sound | null;
     character: Character | null;
     voiceId: string | number | null;
-    color: Color;
+    color?: Color;
 } & Font;
 export type SentenceUserConfig = Partial<Omit<SentenceConfig, "voice"> & {
     voice: Sound | string | null | undefined;
 }>;
+export type DynamicWord = (ctx: ScriptCtx) => DynamicWordResult;
+export type DynamicWordResult = string | Word | Pausing | (string | Word | Pausing)[];
+export type StaticWord<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> = string | Pausing | Word<T>;
+export type SingleWord = StaticWord | DynamicWord;
+export type SentencePrompt = SingleWord[] | SingleWord;
 export declare class Sentence {
     constructor(text: SentencePrompt, config?: SentenceUserConfig);
     copy(): Sentence;

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

@@ -5,6 +5,8 @@ export type WordConfig = {
     className: string;
     ruby: string;
     color: Color;
+    pause: boolean;
+    cps?: number;
 } & Font;
 export declare class Word<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> {
     static isWord(obj: any): obj is Word;

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

@@ -5,7 +5,7 @@ import { Actionable } from "../action/actionable";
 import { Chained, Proxied } from "../action/chain";
 import { Sentence, SentencePrompt, SentenceUserConfig, SingleWord } from "../elements/character/sentence";
 export type CharacterConfig = {
-    color: Color;
+    color?: Color;
 };
 export interface Character {
     (content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;

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

@@ -17,8 +17,15 @@ export type MenuData = {
     choices: Choice[];
 };
 export declare class Menu extends Actionable<any, Menu> {
+    /**
+     * Create a menu with a prompt
+     * @param prompt - The prompt to display to the player
+     * @returns A new menu
+     */
+    static prompt(prompt: SentencePrompt | Sentence, config?: MenuConfig): Menu;
     constructor(prompt: SentencePrompt, config?: MenuConfig);
     constructor(prompt: Sentence, config?: MenuConfig);
+    constructor(prompt: SentencePrompt | Sentence, config: MenuConfig);
     /**
      * Add a choice to the menu
      * @example

package/dist/game/nlcore/elements/persistent/storable.d.ts

@@ -7,6 +7,7 @@ export declare class Namespace<T extends NameSpaceContent<keyof T>> {
     get<Key extends keyof T = any>(key: Key): T[Key];
     equals<Key extends keyof T = any>(key: Key, value: T[Key]): boolean;
     assign(values: Partial<T>): this;
+    reset(): this;
 }
 export declare class Storable {
     addNamespace<T extends NameSpaceContent<keyof T>>(namespace: Namespace<T>): this | undefined;

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

@@ -7,10 +7,21 @@ import { LambdaHandler } from "../elements/type";
 export declare class Persistent<T extends PersistentContent> extends Actionable<null> {
     constructor(namespace: string, defaultContent: T);
     /**
+     * Create an action to set a value in the persistent storage for the given key
      * @chainable
+     * @param key - The key to set the value for
+     * @param value - The value to set
+     * @returns A chainable persistent action
      */
     set<K extends StringKeyOf<T>>(key: K, value: T[K]): ChainedPersistent<T>;
     set<K extends StringKeyOf<T>>(key: K, handler: (value: T[K]) => T[K]): ChainedPersistent<T>;
+    /**
+     * Create an action to assign a value to the persistent storage
+     * @chainable
+     * @param value - The value to assign
+     * @returns A chainable persistent action
+     */
+    assign(value: Partial<T>): ChainedPersistent<T>;
     /**
      * Determine whether the values are equal, can be used in {@link Condition}
      */
@@ -36,6 +47,10 @@ export declare class Persistent<T extends PersistentContent> extends Actionable<
      * @example
      * ```typescript
      * character.say(["You have ", persis.toWord("gold"), " gold"]);
+     *
+     * // or
+     *
+     * character.say`You have ${persis.toWord("gold")} gold`;
      * ```
      */
     toWord<K extends StringKeyOf<T>>(key: K): Word<DynamicWord>;

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

@@ -56,12 +56,6 @@ export declare class Scene extends Constructable<LogicAction.Actions, Scene> {
      * @chainable
      */
     jumpTo(scene: Scene, config?: Partial<JumpConfig> | JumpConfig["transition"]): ChainableAction;
-    /**
-     * Wait for a period of time, the parameter can be the number of milliseconds or a Promise
-     * @chainable
-     */
-    sleep(ms: number): ChainedScene;
-    sleep(promise: Promise<any>): ChainedScene;
     /**
      * Set background music
      * @param sound Target music

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

@@ -16,8 +16,8 @@ export declare class ServiceSkeleton<Content extends ServiceContentType = Servic
      * @param key action type
      * @param handler handler, the arguments are the same as the action content type
      */
-    onAction<K extends StringKeyOf<Content>>(key: K, handler: ServiceHandler<Content[K]>): this;
-    action<K extends StringKeyOf<Content>>(type: K, ...args: Content[K]): Proxied<this, Chained<ServiceAction, this>>;
+    on<K extends StringKeyOf<Content>>(key: K, handler: ServiceHandler<Content[K]>): this;
+    trigger<K extends StringKeyOf<Content>>(type: K, ...args: Content[K]): Proxied<this, Chained<ServiceAction, this>>;
 }
 declare class ServiceSkeletonMask<Content extends ServiceContentType = ServiceContentType, RawData extends Record<string, SerializableData> | null = never> extends ServiceSkeleton<Content, RawData> {
     private triggerAction;
@@ -39,11 +39,7 @@ declare class ServiceSkeletonMask<Content extends ServiceContentType = ServiceCo
     private __self;
     private __actions;
 }
-type AbortifyFn<T extends any[]> = ServiceHandler<T> & {
-    onAbort: (handler: () => void) => AbortifyFn<T>;
-};
 export declare abstract class Service<Content extends ServiceContentType = ServiceContentType, RawData extends Record<string, SerializableData> | null = Record<string, any>> extends ServiceSkeletonMask<Content, RawData> {
-    static abortify<T extends any[]>(fn: ServiceHandler<T>): AbortifyFn<T>;
     /**
      * Serialize the service to data
      *
@@ -55,5 +51,9 @@ export declare abstract class Service<Content extends ServiceContentType = Servi
      * @param data data exported from toData
      */
     abstract deserialize?(data: RawData): void;
+    /**
+     * Called when the service is initialized
+     */
+    abstract init?(): void;
 }
 export {};

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

@@ -41,6 +41,9 @@ export declare class Sound extends Actionable<SoundDataRaw, Sound> {
     constructor(config?: Partial<ISoundUserConfig>);
     constructor(src?: string);
     /**
+     * Start playing the sound
+     *
+     * This action will be resolved when the sound reaches the end
      * @chainable
      */
     play(duration?: number): ChainedSound;

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

@@ -1,7 +1,7 @@
 import { Constructable } from "../action/constructable";
 import { Scene } from "../elements/scene";
 import { SceneAction } from "../action/actions/sceneAction";
-import { Persistent } from "../elements/persistent";
+import { Persistent, PersistentContent } from "../elements/persistent";
 import { Service } from "../elements/service";
 export declare enum Origins {
     topLeft = "top left",
@@ -48,6 +48,22 @@ export declare class Story extends Constructable<SceneAction<"scene:action">, St
      * You can't use a Persistent that isn't registered to the story
      */
     registerPersistent(persistent: Persistent<any>): this;
+    /**
+     * Create a Persistent and register it to the story
+     * @example
+     * ```typescript
+     * const persistent = story.createPersistent("playerData", {
+     *   name: "persistent",
+     * });
+     *
+     * // is equivalent to
+     * const persistent = new Persistent("playerData", {
+     *   name: "persistent",
+     * });
+     * story.registerPersistent(persistent);
+     * ```
+     */
+    createPersistent<T extends PersistentContent>(namespace: string, defaultContent: T): Persistent<T>;
     /**
      * Register a Service to the story
      *