narraleaf-react 0.1.4 → 0.1.6

package/README.md

@@ -45,9 +45,9 @@ npm start
 
 ## License
 
-> NarraLeaf-React is licensed under the MPL License.
+> NarraLeaf-React is licensed under the MPL-2.0 License.
 >
-> We updated the license to MPL on 2024-9-24.
+> We updated the license to MPL-2.0 on 2024-9-24.
 
 ## Contributing
 

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

@@ -1,4 +1,5 @@
-import { Game, LiveGame } from "../game";
+import { Game } from "../game";
 import { GameState } from "../../player/gameState";
 import { Storable, Namespace } from "../store/storable";
+import { LiveGame } from "../liveGame";
 export { LiveGame, GameState, Game, Storable, Namespace, };

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

@@ -1,7 +1,8 @@
-import { Game, LiveGame } from "../game";
+import { Game } from "../game";
 import { Actionable } from "../action/actionable";
 import { GameState } from "../../player/gameState";
 import type { Storable } from "../store/storable";
+import { LiveGame } from "../liveGame";
 export interface ScriptCtx {
     gameState: GameState;
     game: Game;

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

@@ -0,0 +1,31 @@
+import { EventDispatcher } from "../../../util/data";
+type PreferenceEventToken = {
+    cancel: () => void;
+};
+type StringKeyof<T> = Extract<keyof T, string>;
+export declare class Preference<T extends Record<string, string | boolean | number | null | undefined>> {
+    private readonly settings;
+    static EventTypes: {
+        readonly "event:game.preference.change": "event:game.preference.change";
+    };
+    readonly events: EventDispatcher<{
+        "event:game.preference.change": [StringKeyof<T>, any];
+    }>;
+    constructor(settings: T);
+    setPreference<K extends StringKeyof<T>>(key: K, value: T[K]): void;
+    getPreference<K extends StringKeyof<T>>(key: K): T[K];
+    getPreferences(): T;
+    onPreferenceChange<U extends StringKeyof<T>>(key: U, listener: (value: T[U]) => void): PreferenceEventToken;
+    onPreferenceChange(listener: (key: StringKeyof<T>, value: T[StringKeyof<T>]) => void): PreferenceEventToken;
+    /**
+     * Import preferences
+     *
+     * Note: This will override the existing preferences, and trigger the change event
+     */
+    importPreferences(preferences: Partial<T>): void;
+    /**
+     * Export preferences
+     */
+    exportPreferences(): Partial<T>;
+}
+export {};

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

@@ -1,17 +1,25 @@
-import type { GameConfig, SavedGame } from "./gameTypes";
-import { DeepPartial, MultiLock } from "../../util/data";
-import { Storable } from "./store/storable";
+import type { GameConfig } from "./gameTypes";
+import { DeepPartial } from "../../util/data";
 import { LogicAction } from "./action/logicAction";
-import { GameState } from "../player/gameState";
 import { ComponentsTypes } from "../player/elements/type";
+import { LiveGame } from "./liveGame";
+import { Preference } from "./game/preference";
 declare enum GameSettingsNamespace {
     game = "game"
 }
+export type GamePreference = {
+    autoForward: boolean;
+    skip: boolean;
+};
 export declare class Game {
     static ComponentTypes: {
-        [K in keyof ComponentsTypes]: K;
+        readonly [K in keyof ComponentsTypes]: K;
     };
     static GameSettingsNamespace: typeof GameSettingsNamespace;
+    /**
+     * Game settings
+     */
+    preference: Preference<GamePreference>;
     /**
      * Create a new game
      * @param config - Game configuration
@@ -23,38 +31,6 @@ export declare class Game {
     useComponent<T extends keyof ComponentsTypes>(key: T, components: ComponentsTypes[T]): this;
     getLiveGame(): LiveGame;
 }
-export declare class LiveGame {
-    static DefaultNamespaces: {
-        game: {};
-    };
-    static GameSpacesKey: {
-        readonly game: "game";
-    };
-    game: Game;
-    gameLock: MultiLock;
-    getStorable(): Storable;
-    /**
-     * Serialize the current game state
-     *
-     * You can use this to save the game state to a file or a database
-     *
-     * Note: Even if you change just a single line of script, the saved game might not be compatible with the new version
-     */
-    serialize(): SavedGame;
-    /**
-     * Load a saved game
-     *
-     * Note: Even if you change just a single line of script, the saved game might not be compatible with the new version
-     *
-     * After calling this method, the current game state will be lost, and the stage will trigger force reset
-     */
-    deserialize(savedGame: SavedGame): void;
-    /**
-     * Start a new game
-     */
-    newGame(): this;
-    getGameState(): GameState | undefined;
-}
 declare const _default: {
     Game: typeof Game;
     LiveGame: typeof LiveGame;

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

@@ -89,6 +89,10 @@ export type GameConfig = {
              * Text will look smaller when this is enabled
              */
             useAspectScale: boolean;
+            /**
+             * The delay in milliseconds before the game automatically shows the next sentence
+             */
+            autoForwardDelay: number;
         };
         img: {
             /**

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

@@ -0,0 +1,37 @@
+import { MultiLock } from "../../util/data";
+import type { SavedGame } from "./gameTypes";
+import { GameState } from "../player/gameState";
+import { Storable } from "./store/storable";
+import { Game } from "./game";
+export declare class LiveGame {
+    static DefaultNamespaces: {
+        game: {};
+    };
+    static GameSpacesKey: {
+        readonly game: "game";
+    };
+    game: Game;
+    gameLock: MultiLock;
+    getStorable(): Storable;
+    /**
+     * Serialize the current game state
+     *
+     * You can use this to save the game state to a file or a database
+     *
+     * Note: Even if you change just a single line of script, the saved game might not be compatible with the new version
+     */
+    serialize(): SavedGame;
+    /**
+     * Load a saved game
+     *
+     * Note: Even if you change just a single line of script, the saved game might not be compatible with the new version
+     *
+     * After calling this method, the current game state will be lost, and the stage will trigger force reset
+     */
+    deserialize(savedGame: SavedGame): void;
+    /**
+     * Start a new game
+     */
+    newGame(): this;
+    getGameState(): GameState | undefined;
+}

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

@@ -1,7 +1,6 @@
 import { IPosition, RawPosition } from "./elements/transform/position";
 import { ITransition } from "./elements/transition/type";
 import { Transform } from "./elements/transform/transform";
-import { EventDispatcher } from "../../util/data";
 import React from "react";
 export type color = string | {
     r: number;
@@ -62,6 +61,4 @@ export type EventfulDisplayableEvents = {
     [K in DisplayableAnimationEvents]: K extends "event:displayable.applyTransform" ? [Transform] : K extends "event:displayable.applyTransition" ? [ITransition] : K extends "event:displayable.init" ? [] : never;
 };
 export interface EventfulDisplayable {
-    events: EventDispatcher<EventfulDisplayableEvents>;
-    toDisplayableTransform(): Transform;
 }

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

@@ -2,4 +2,4 @@ import "client-only";
 import "@player/lib/styles/style.css";
 import React from "react";
 import { PlayerProps } from "../elements/type";
-export default function Player({ story, width, height, className, onReady, onEnd, }: Readonly<PlayerProps>): React.JSX.Element;
+export default function Player({ story, width, height, className, onReady, onEnd, children, }: Readonly<PlayerProps>): React.JSX.Element;

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

@@ -3,9 +3,10 @@ import { SayElementProps } from "../elements/say/type";
 import { MenuElementProps } from "../elements/menu/type";
 import { Story } from "../../nlcore/elements/story";
 import clsx from "clsx";
-import { Game, LiveGame } from "../../nlcore/game";
+import { Game } from "../../nlcore/game";
 import { GameState } from "../gameState";
 import { Storable } from "../../nlcore/store/storable";
+import { LiveGame } from "../../nlcore/liveGame";
 export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
 export type SayComponent = Components<SayElementProps>;
 export type MenuComponent = Components<MenuElementProps>;
@@ -28,13 +29,14 @@ export interface PlayerProps {
     /**
      * Once the game is ready to be played
      *
-     * only called once each lifecycle
+     * only called each lifecycle once
      */
     onReady?: (ctx: PlayerEventContext) => void;
     /**
      * Once the game is ended
      *
-     * only called once each lifecycle
+     * only called each lifecycle once
      */
     onEnd?: (ctx: PlayerEventContext) => void;
+    children?: React.ReactNode;
 }

package/dist/game/player/lib/PlayerFrames.d.ts

@@ -0,0 +1,25 @@
+import React from "react";
+type ForwardSize = {
+    width?: React.CSSProperties["width"];
+    height?: React.CSSProperties["height"];
+};
+type ForwardChildren = {
+    children?: React.ReactNode;
+};
+type FrameComponentProps = ForwardSize & ForwardChildren;
+declare const Top: {
+    Left: (props: FrameComponentProps) => React.JSX.Element;
+    Center: (props: FrameComponentProps) => React.JSX.Element;
+    Right: (props: FrameComponentProps) => React.JSX.Element;
+};
+declare const Center: {
+    Left: (props: FrameComponentProps) => React.JSX.Element;
+    Center: (props: FrameComponentProps) => React.JSX.Element;
+    Right: (props: FrameComponentProps) => React.JSX.Element;
+};
+declare const Bottom: {
+    Left: (props: FrameComponentProps) => React.JSX.Element;
+    Center: (props: FrameComponentProps) => React.JSX.Element;
+    Right: (props: FrameComponentProps) => React.JSX.Element;
+};
+export { Top, Center, Bottom, };

package/dist/game/player/lib/UtilComponents.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import { DivElementProp } from "../../nlcore/elements/transition/type";
+declare const VBox: React.ForwardRefExoticComponent<DivElementProp>;
+declare const HBox: React.ForwardRefExoticComponent<DivElementProp>;
+export { VBox, HBox, };

package/dist/game/player/libElements.d.ts

@@ -1,3 +1,5 @@
 import Isolated from "./lib/isolated";
 import Say from "./elements/say/Say";
-export { Isolated, Say, };
+import { Top, Center, Bottom } from "./lib/PlayerFrames";
+import { VBox, HBox } from "./lib/UtilComponents";
+export { Isolated, Say, Top, Center, Bottom, VBox, HBox, };