narraleaf-react 0.2.4-beta.4 → 0.3.0-beta.1

package/README.md

@@ -19,29 +19,114 @@ It doesn't use any rendering libraries and can be used on any web platform (e.g.
 - **Customizable**: You can customize the UI as you like, even replace the whole components.
 - **Easy to use**: It is easy to use and has a simple API that is built for developers. Based on OOP principles.
 
-## Get Started
+### Scripting
 
-### Install
+NarraLeaf-React uses TypeScript for all scripting, so you don't have to learn a whole new language to use it.
 
-```bash
-npm install narraleaf-react
+It also has a highly abstracted and easy-to-use API, for example:
+
+```typescript
+import {Character, Menu, Scene, Word} from "narraleaf-react";
 ```
 
-### Documentation
+```typescript
+const scene1 = new Scene("scene1_hello_world", {
+    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!"),
+    
+    /**
+     * 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!")
+        ])
+]);
+```
 
-Read more in [🛠React.NarraLeaf.com](https://react.narraleaf.com)
+For more information, please visit [🛠React.NarraLeaf.com](https://react.narraleaf.com)
 
-### Example
+## Get Started
+
+### Install
 
 ```bash
-npx create-react-app nlr-app --template my-first-narraleaf-app
+npm install narraleaf-react
 ```
 
-to start
+### Documentation
+
+- [Introduction](https://react.narraleaf.com/documentation/introduction)
+- [Quick Start](https://react.narraleaf.com/documentation/quick-start)
+- [Installation](https://react.narraleaf.com/documentation/installation)
+- [Basic](https://react.narraleaf.com/documentation/basic)
+  - [Create a Scene](https://react.narraleaf.com/documentation/basic/create-scene)
+  - [Add Actions](https://react.narraleaf.com/documentation/basic/add-actions)
+  - [Show Dialog](https://react.narraleaf.com/documentation/basic/show-dialog)
+  - [Show Image](https://react.narraleaf.com/documentation/basic/show-image)
+  - [Play Story](https://react.narraleaf.com/documentation/basic/play-story)
+  - [Make Choices](https://react.narraleaf.com/documentation/basic/make-choices)
+  - [Play Sound](https://react.narraleaf.com/documentation/basic/sound)
+  - [Store Data](https://react.narraleaf.com/documentation/basic/store-data)
+  - [Conditional](https://react.narraleaf.com/documentation/basic/conditional)
+  - [Voice](https://react.narraleaf.com/documentation/basic/voice)
+  - [Manage Preferences](https://react.narraleaf.com/documentation/basic/manage-preferences)
+- [Core](https://react.narraleaf.com/documentation/core)
+  - [Elements](https://react.narraleaf.com/documentation/core/elements)
+    - [Scene](https://react.narraleaf.com/documentation/core/elements/scene)
+    - [Character](https://react.narraleaf.com/documentation/core/elements/character)
+      - [Sentence](https://react.narraleaf.com/documentation/core/elements/character/sentence)
+      - [Word](https://react.narraleaf.com/documentation/core/elements/character/word)
+      - [Pause](https://react.narraleaf.com/documentation/core/elements/character/pause)
+    - [Image](https://react.narraleaf.com/documentation/core/elements/image)
+    - [Sound](https://react.narraleaf.com/documentation/core/elements/sound)
+    - [Menu](https://react.narraleaf.com/documentation/core/elements/menu)
+    - [Script](https://react.narraleaf.com/documentation/core/elements/script)
+    - [Condition](https://react.narraleaf.com/documentation/core/elements/condition)
+    - [Control](https://react.narraleaf.com/documentation/core/elements/control)
+    - [Text](https://react.narraleaf.com/documentation/core/elements/text)
+    - [Persistent](https://react.narraleaf.com/documentation/core/elements/persistent)
+    - [Story](https://react.narraleaf.com/documentation/core/elements/story)
+  - [Animation](https://react.narraleaf.com/documentation/core/animation)
+  - [Game](https://react.narraleaf.com/documentation/core/game)
+- [Player](https://react.narraleaf.com/documentation/player)
+- [Customization](https://react.narraleaf.com/documentation/custom)
+- [Migration](https://react.narraleaf.com/documentation/migration)
+  - [From Ren'Py](https://react.narraleaf.com/documentation/migration/from-renpy)
+- Info
+  - [License](https://react.narraleaf.com/documentation/info/license)
+  - [Incompatible Changes](https://react.narraleaf.com/documentation/info/incompatible-changes)
 
-```bash
-npm start
-```
+Read more in [🛠React.NarraLeaf.com](https://react.narraleaf.com)
 
 ## License
 

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

@@ -4,6 +4,7 @@ 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;
@@ -19,5 +20,5 @@ export declare class Action<ContentNodeType = any, Callee = LogicAction.GameElem
     setId(id: string): void;
     setContent(content: ContentNodeType): this;
     setContentNode(contentNode: ContentNode<ContentNodeType>): this;
-    getFutureActions(_story: Story): LogicAction.Actions[];
+    getFutureActions(_story: Story, _options: ActionSearchOptions): LogicAction.Actions[];
 }

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

@@ -1,17 +1,30 @@
 import { LogicAction } from "../action/logicAction";
 import type { Story } from "../elements/story";
 import type { ConditionData } from "../elements/condition";
-import { CommonDisplayable, ImageColor, ImageSrc } from "../types";
+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 { IImageTransition, ITransition } from "../elements/transition/type";
+import { ITransition } from "../elements/transition/type";
 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";
@@ -22,19 +35,16 @@ export type CharacterActionContentType = {
 };
 export declare const SceneActionTypes: {
     readonly action: "scene:action";
-    readonly setBackground: "scene:setBackground";
     readonly sleep: "scene:sleep";
-    readonly applyTransition: "scene:applyTransition";
     readonly init: "scene:init";
     readonly exit: "scene:exit";
     readonly jumpTo: "scene:jumpTo";
     readonly setBackgroundMusic: "scene:setBackgroundMusic";
     readonly preUnmount: "scene:preUnmount";
-    readonly applyTransform: "scene:applyTransform";
     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["setBackground"] ? [ImageSrc | ImageColor] : K extends typeof SceneActionTypes["applyTransition"] ? [ITransition] : K extends typeof SceneActionTypes["init"] ? [Scene | string] : K extends typeof SceneActionTypes["exit"] ? [] : K extends typeof SceneActionTypes["jumpTo"] ? [Scene | string] : K extends typeof SceneActionTypes["setBackgroundMusic"] ? [Sound | null, number?] : K extends typeof SceneActionTypes["preUnmount"] ? [] : K extends typeof SceneActionTypes["applyTransform"] ? [Transform] : K extends typeof SceneActionTypes["transitionToScene"] ? [IImageTransition, Scene | string | undefined, ImageSrc | ImageColor | undefined] : any;
+    [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;
 };
 export declare const StoryActionTypes: {
     readonly action: "story:action";
@@ -45,24 +55,13 @@ export type StoryActionContentType = {
 export declare const ImageActionTypes: {
     readonly action: "image:action";
     readonly setSrc: "image:setSrc";
-    readonly setPosition: "image:setPosition";
-    readonly show: "image:show";
-    readonly hide: "image:hide";
-    readonly applyTransform: "image:applyTransform";
-    readonly init: "image:init";
-    readonly dispose: "image:dispose";
-    /**
-     * @deprecated
-     */
-    readonly setTransition: "image:setTransition";
-    readonly applyTransition: "image:applyTransition";
     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" ? [string] : K extends "image:setPosition" ? [CommonDisplayable["position"], Transform<TransformDefinitions.ImageTransformProps>] : K extends "image:show" ? [void, Transform<TransformDefinitions.ImageTransformProps>] : K extends "image:hide" ? [void, Transform<TransformDefinitions.ImageTransformProps>] : K extends "image:applyTransform" ? [void, Transform<TransformDefinitions.ImageTransformProps>, string] : K extends "image:init" ? [Scene?] : K extends "image:dispose" ? [] : K extends "image:setTransition" ? [ITransition | null] : K extends "image:applyTransition" ? [ITransition] : K extends "image:flush" ? [] : K extends "image:initWearable" ? [Image] : K extends "image:setAppearance" ? [FlexibleTuple<SelectElementFromEach<TagGroupDefinition>> | string[], IImageTransition | 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] : any;
+} & DisplayableActionContentType<ImageTransition>;
 export declare const ConditionActionTypes: {
     readonly action: "condition:action";
 };
@@ -85,20 +84,13 @@ export declare const SoundActionTypes: {
     readonly action: "sound:action";
     readonly play: "sound:play";
     readonly stop: "sound:stop";
-    readonly fade: "sound:fade";
     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" ? [void] : K extends "sound:stop" ? [void] : K extends "sound:fade" ? [
-        {
-            start?: number;
-            end: number;
-            duration: number;
-        }
-    ] : K extends "sound:setVolume" ? [number] : K extends "sound:setRate" ? [number] : K extends "sound:pause" ? [void] : K extends "sound:resume" ? [void] : any;
+    [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";
@@ -116,26 +108,11 @@ export type ControlActionContentType = {
 export declare const TextActionTypes: {
     readonly action: "text:action";
     readonly setText: "text:setText";
-    readonly show: "text:show";
-    readonly hide: "text:hide";
-    readonly applyTransform: "text:applyTransform";
-    readonly init: "text:init";
-    readonly applyTransition: "text:applyTransition";
     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:applyTransition" ? [ITransition] : K extends "text:setFontSize" ? [number] : any;
 };
-export declare const DisplayableActionTypes: {
-    readonly action: "displayable:action";
-    readonly layerMoveUp: "displayable:layerMoveUp";
-    readonly layerMoveDown: "displayable:layerMoveDown";
-    readonly layerMoveTop: "displayable:layerMoveTop";
-    readonly layerMoveBottom: "displayable:layerMoveBottom";
-};
-export type DisplayableActionContentType = {
-    [K in typeof DisplayableActionTypes[keyof typeof DisplayableActionTypes]]: K extends "displayable:layerMoveUp" ? [void] : K extends "displayable:layerMoveDown" ? [void] : K extends "displayable:layerMoveTop" ? [void] : K extends "displayable:layerMoveBottom" ? [void] : any;
-};
 export declare const PersistentActionTypes: {
     readonly action: "persistent:action";
     readonly set: "persistent:set";
@@ -143,3 +120,9 @@ export declare const PersistentActionTypes: {
 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;
 };
+export declare const LayerActionTypes: {
+    readonly action: "layer:action";
+};
+export type LayerActionContentType = {
+    [K in typeof LayerActionTypes[keyof typeof LayerActionTypes]]: K extends "layer:action" ? any : any;
+};

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

@@ -4,6 +4,7 @@ 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";
@@ -12,5 +13,5 @@ export declare class ConditionAction<T extends typeof ConditionActionTypes[keyof
         type: any;
         node: import("../tree/actionTree").RenderableNode | null;
     };
-    getFutureActions(story: Story): LogicAction.Actions[];
+    getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
 }

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

@@ -7,6 +7,7 @@ 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";
 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";
@@ -29,5 +30,5 @@ export declare class ControlAction<T extends typeof ControlActionTypes[keyof typ
         node: ContentNode<any> | null;
     } | Awaitable<CalledActionResult<any>, any> | Awaitable<any, any>;
     executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, CalledActionResult>;
-    getFutureActions(story: Story): LogicAction.Actions[];
+    getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
 }

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

@@ -1,15 +1,22 @@
 import { DisplayableActionContentType, DisplayableActionTypes } from "../../action/actionTypes";
 import { GameState } from "../../../player/gameState";
 import { TypedAction } from "../../action/actions";
-import { Values } from "../../../../util/data";
+import { Awaitable, Values } from "../../../../util/data";
 import { Displayable } from "../../elements/displayable/displayable";
-export declare class DisplayableAction<T extends Values<typeof DisplayableActionTypes> = Values<typeof DisplayableActionTypes>, Self extends Displayable<any, any> = Displayable<any, any>> extends TypedAction<DisplayableActionContentType, T, Self> {
+import type { CalledActionResult } from "../../gameTypes";
+import { Scene } from "../../elements/scene";
+import { Transform } from "../../elements/transform/transform";
+import { Transition } from "../../elements/transition/transition";
+import { Layer } from "../../elements/layer";
+export declare class DisplayableAction<T extends Values<typeof DisplayableActionTypes> = Values<typeof DisplayableActionTypes>, Self extends Displayable<any, any, any> = Displayable<any, any>, TransitionType extends Transition = Transition> extends TypedAction<DisplayableActionContentType<TransitionType>, T, Self> {
     static ActionTypes: {
         readonly action: "displayable:action";
-        readonly layerMoveUp: "displayable:layerMoveUp";
-        readonly layerMoveDown: "displayable:layerMoveDown";
-        readonly layerMoveTop: "displayable:layerMoveTop";
-        readonly layerMoveBottom: "displayable:layerMoveBottom";
+        readonly applyTransform: "displayable:applyTransform";
+        readonly applyTransition: "displayable:applyTransition";
+        readonly init: "displayable:init";
     };
-    executeAction(gameState: GameState): import("../../gameTypes").CalledActionResult<any> | import("../../../../util/data").Awaitable<import("../../gameTypes").CalledActionResult<any>, any>;
+    executeAction(gameState: GameState): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
+    applyTransform(state: GameState, element: Displayable<any, any>, transform: Transform, onFinished?: () => void): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
+    applyTransition(state: GameState, element: Displayable<any, any>, transition: TransitionType, onFinished?: () => void): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
+    initDisplayable(state: GameState, scene: Scene | null, element: Displayable<any, any>, layer: Layer | null, isElement?: boolean | undefined): Awaitable<CalledActionResult>;
 }

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

@@ -5,22 +5,17 @@ import type { CalledActionResult } from "../../gameTypes";
 import { Awaitable } from "../../../../util/data";
 import { ContentNode } from "../../action/tree/actionTree";
 import { TypedAction } from "../../action/actions";
+import { Color } from "../../types";
 export declare class ImageAction<T extends typeof ImageActionTypes[keyof typeof ImageActionTypes] = typeof ImageActionTypes[keyof typeof ImageActionTypes]> extends TypedAction<ImageActionContentType, T, Image> {
     static ActionTypes: {
         readonly action: "image:action";
         readonly setSrc: "image:setSrc";
-        readonly setPosition: "image:setPosition";
-        readonly show: "image:show";
-        readonly hide: "image:hide";
-        readonly applyTransform: "image:applyTransform";
-        readonly init: "image:init";
-        readonly dispose: "image:dispose";
-        readonly setTransition: "image:setTransition";
-        readonly applyTransition: "image:applyTransition";
         readonly flush: "image:flush";
         readonly initWearable: "image:initWearable";
         readonly setAppearance: "image:setAppearance";
     };
+    static resolveTagSrc(image: Image, tags: string[]): string;
+    static resolveCurrentSrc(image: Image): string | Color;
     type: T;
     contentNode: ContentNode<ImageActionContentType[T]>;
     executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;

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

@@ -0,0 +1,12 @@
+import { LayerActionContentType, LayerActionTypes } from "../../action/actionTypes";
+import { TypedAction } from "../../action/actions";
+import { GameState } from "../../../player/gameState";
+import { CalledActionResult } from "../../gameTypes";
+import { Awaitable, Values } from "../../../../util/data";
+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";
+    };
+    executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
+}

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

@@ -5,10 +5,12 @@ import { Awaitable } from "../../../../util/data";
 import type { CalledActionResult } from "../../gameTypes";
 import { TypedAction } from "../../action/actions";
 import { Story } from "../../elements/story";
+import { LogicAction } from "../../action/logicAction";
+import { ActionSearchOptions } from "../../types";
 export declare class MenuAction<T extends typeof MenuActionTypes[keyof typeof MenuActionTypes] = typeof MenuActionTypes[keyof typeof MenuActionTypes]> extends TypedAction<MenuActionContentType, T, Menu> {
     static ActionTypes: {
         readonly action: "menu:action";
     };
     executeAction(state: GameState): Awaitable<CalledActionResult<any>, CalledActionResult<any>>;
-    getFutureActions(story: Story): import("../logicAction").LogicAction.Actions[];
+    getFutureActions(story: Story, options: ActionSearchOptions): LogicAction.Actions[];
 }

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

@@ -5,30 +5,29 @@ import { Awaitable } from "../../../../util/data";
 import type { CalledActionResult } from "../../gameTypes";
 import { LogicAction } from "../../action/logicAction";
 import { TypedAction } from "../../action/actions";
-import { ITransition } from "../../elements/transition/type";
 import { Story } from "../../elements/story";
+import { ImageTransition } from "../../elements/transition/transitions/image/imageTransition";
+import { ActionSearchOptions } from "../../types";
+import { ExposedState, ExposedStateType } from "../../../player/type";
 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 setBackground: "scene:setBackground";
         readonly sleep: "scene:sleep";
-        readonly applyTransition: "scene:applyTransition";
         readonly init: "scene:init";
         readonly exit: "scene:exit";
         readonly jumpTo: "scene:jumpTo";
         readonly setBackgroundMusic: "scene:setBackgroundMusic";
         readonly preUnmount: "scene:preUnmount";
-        readonly applyTransform: "scene:applyTransform";
         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 registerEventListeners(scene: Scene, state: GameState, onInit?: () => void): void;
-    applyTransition(state: GameState, transition: ITransition): Awaitable<CalledActionResult<any>, CalledActionResult<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>;
-    getFutureActions(story: Story): LogicAction.Actions[];
+    getFutureActions(story: Story, searchOptions?: ActionSearchOptions): LogicAction.Actions[];
     _sceneNotFoundError(sceneId: string): Error;
     getSceneName(scene: Scene | string): string;
 }

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

@@ -9,12 +9,10 @@ export declare class SoundAction<T extends typeof SoundActionTypes[keyof typeof
         readonly action: "sound:action";
         readonly play: "sound:play";
         readonly stop: "sound:stop";
-        readonly fade: "sound:fade";
         readonly setVolume: "sound:setVolume";
         readonly setRate: "sound:setRate";
         readonly pause: "sound:pause";
         readonly resume: "sound:resume";
     };
-    static initSound(state: GameState, sound: Sound): void;
     executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
 }

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

@@ -8,11 +8,6 @@ export declare class TextAction<T extends typeof TextActionTypes[keyof typeof Te
     static ActionTypes: {
         readonly action: "text:action";
         readonly setText: "text:setText";
-        readonly show: "text:show";
-        readonly hide: "text:hide";
-        readonly applyTransform: "text:applyTransform";
-        readonly init: "text:init";
-        readonly applyTransition: "text:applyTransition";
         readonly setFontSize: "text:setFontSize";
     };
     executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;

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

@@ -5,11 +5,11 @@ import type { Image } from "../elements/displayable/image";
 import type { Condition } from "../elements/condition";
 import type { Script } from "../elements/script";
 import type { Menu } from "../elements/menu";
-import { Values } from "../../../util/data";
+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, 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 } from "../action/actionTypes";
 import { CharacterAction } from "../action/actions/characterAction";
 import { SceneAction } from "../action/actions/sceneAction";
 import { StoryAction } from "../action/actions/storyAction";
@@ -25,10 +25,16 @@ import { Displayable as AbstractDisplayable } from "../elements/displayable/disp
 import { DisplayableAction } from "../action/actions/displayableAction";
 import { Persistent } from "../elements/persistent";
 import { PersistentAction } from "../action/actions/persistentAction";
+import { ServiceSkeleton } from "../elements/service";
+import { ServiceAction, ServiceActionContentType } from "../action/serviceAction";
+import { Layer } from "../elements/layer";
+import { LayerAction } from "../action/actions/layerAction";
+import { ExposedStateType } from "../../player/type";
 export declare namespace LogicAction {
-    type DisplayableElements = Text | Image | AbstractDisplayable<any, any>;
-    type GameElement = Character | Scene | Story | Image | Condition | Script | Menu | Sound | Control | Text | AbstractDisplayable<any, any> | Persistent<any>;
-    type Actions = TypedAction | CharacterAction | ConditionAction | ImageAction | SceneAction | ScriptAction | StoryAction | MenuAction | SoundAction | ControlAction | TextAction | DisplayableAction | PersistentAction;
-    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>;
-    type ActionContents = CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType;
+    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;
 }

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

@@ -0,0 +1,11 @@
+import { TypedAction } from "../action/actions";
+import { Awaitable, StringKeyOf } from "../../../util/data";
+import { ServiceSkeleton } from "../elements/service";
+import { GameState } from "../../player/gameState";
+import { CalledActionResult } from "../gameTypes";
+export type ServiceActionContentType = {
+    "service:action": [type: string, args: unknown[]];
+};
+export declare class ServiceAction extends TypedAction<ServiceActionContentType, StringKeyOf<ServiceActionContentType>, ServiceSkeleton> {
+    executeAction(gameState: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;
+}

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

@@ -6,7 +6,7 @@ import { LogicAction } from "../action/logicAction";
 export type SrcType = "image" | "video" | "audio";
 export type Src = {
     type: "image";
-    src: Image;
+    src: Image | string;
 } | {
     type: "video";
     src: string;
@@ -22,11 +22,11 @@ export declare class SrcManager {
         [key in SrcType]: key;
     };
     static catSrc(src: Src[]): {
-        image: Image[];
+        image: (Image | string)[];
         video: string[];
         audio: Sound[];
     };
-    static getSrc(src: Src | string | Image): string;
+    static getSrc(src: Src | string | Image): string | null;
     static getPreloadableSrc(story: Story, action: LogicAction.Actions): (Src & {
         activeType: "scene" | "once";
     }) | null;
@@ -37,7 +37,8 @@ export declare class SrcManager {
     register(src: Sound): this;
     register(src: Image | StaticImageData): this;
     register(type: SrcType, src: Src["src"]): this;
-    isSrcRegistered(src: string | Sound | Image): boolean;
+    registerRawSrc(src: string): this;
+    isSrcRegistered(src: string | Sound | Image | null): boolean;
     getSrc(): Src[];
     getSrcByType(type: SrcType): Src[];
     registerFuture(srcManager: SrcManager): this;

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

@@ -1,4 +1,5 @@
-import type { HexColor, ImageColor } from "../types";
+import type { Color, HexColor } from "../types";
+import { Word } from "../elements/character/word";
 export declare class RGBColor {
     static isHexString(color: any): color is HexColor;
     static fromHex(hex: HexColor): RGBColor;
@@ -9,5 +10,16 @@ export declare class RGBColor {
     constructor(r: number, g: number, b: number, a?: number);
     toString(): string;
     toHex(): string;
-    toImageColor(): ImageColor;
 }
+/**
+ * Alias for {@link Word.color}
+ */
+export declare function c(text: string | Word, color: Color): Word;
+/**
+ * Alias for {@link Word.bold}
+ */
+export declare function b(text: string | Word): Word;
+/**
+ * Alias for {@link Word.italic}
+ */
+export declare function i(text: string | Word): Word;

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

@@ -1,8 +1,8 @@
-import { Utils } from "./Utils";
+import { i, c, b } from "./Utils";
 export * from "./elements";
 export * from "./game";
 export * from "./player";
 export * from "./types";
 export * from "./position";
 export * from "./transition";
-export { Utils };
+export { i, c, b, };