narraleaf-react 0.5.0 → 0.7.0

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

@@ -0,0 +1,22 @@
+/**
+ * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+ *
+ * Case-insensitive
+ */
+export type WebKeyboardKey = string;
+export declare enum KeyBindingType {
+    /**
+     * When the player presses one of these keys, the game will show the next sentence
+     *
+     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+     * @default [" "]
+     */
+    skipAction = "skipAction",
+    /**
+     * When the player presses one of these keys, the game will skip the current action
+     *
+     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+     * @default ["Control"]
+     */
+    nextAction = "nextAction"
+}

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

@@ -1,116 +1,86 @@
-import type { GameConfig } from "./gameTypes";
-import { DeepPartial, Hooks } from "../../util/data";
-import { LogicAction } from "./action/logicAction";
-import { LiveGame } from "./game/liveGame";
-import { Preference } from "./game/preference";
-import { Plugins, IGamePluginRegistry } from "./game/plugin/plugin";
-declare enum GameSettingsNamespace {
-    game = "game"
-}
-export type GamePreference = {
-    /**
-     * If true, the game will automatically forward to the next sentence when the player has finished the current sentence
-     * @default false
-     */
-    autoForward: boolean;
-    /**
-     * If true, the game will allow the player to skip the dialog
-     * @default true
-     */
-    skip: boolean;
-    /**
-     * If true, the game will show the dialog
-     * @default true
-     */
-    showDialog: boolean;
-    /**
-     * The multiplier of the dialog speed
-     *
-     * Dialog speed will apply to:
-     * - The text speed
-     * - The auto-forward delay
-     * @default 1.0
-     */
-    gameSpeed: number;
-    /**
-     * The speed of the text effects in characters per second.
-     * @default 10
-     */
-    cps: number;
-    /**
-     * The volume of the voice
-     * @default 1
-     */
-    voiceVolume: number;
-    /**
-     * The volume of the background music
-     * @default 1
-     */
-    bgmVolume: number;
-    /**
-     * The volume of the sound effects
-     * @default 1
-     */
-    soundVolume: number;
-    /**
-     * The volume of the global audio
-     * @default 1
-     */
-    globalVolume: number;
-};
-export type GameHooks = {
-    /**
-     * Hook when the game is initialized
-     *
-     * This hook's behavior is similar to the `useEffect` hook in React. It will be called twice when the strict mode is enabled.
-     * It is used to configure the game.
-     */
-    "init": [];
-    /**
-     * Hook when preloading images
-     *
-     * @param src - The source of the image
-     * @param set - Calling this function will set the src and options of the fetch request. This is useful to proxy
-     * - **Note**: "signal" is preserved from the original options
-     */
-    "preloadImage": [src: string, set: (src: string, options?: RequestInit) => void];
-};
-export declare class Game {
-    static GameSettingsNamespace: typeof GameSettingsNamespace;
-    readonly hooks: Hooks<GameHooks>;
-    /**
-     * Game settings
-     */
-    preference: Preference<GamePreference>;
-    /**
-     * Plugin registry
-     */
-    plugins: Plugins;
-    /**
-     * Create a new game
-     * @param config - Game configuration
-     */
-    constructor(config: DeepPartial<GameConfig>);
-    /**
-     * Configure the game
-     */
-    configure(config: DeepPartial<GameConfig>): this;
-    /**
-     * Use a plugin
-     * @param plugin - The plugin to use
-     */
-    use(plugin: IGamePluginRegistry): this;
-    getLiveGame(): LiveGame;
-    /**
-     * Dispose the game and all its resources
-     *
-     * **Note**: This action is irreversible.
-     */
-    dispose(): void;
-}
-declare const _default: {
-    Game: typeof Game;
-    LiveGame: typeof LiveGame;
-};
-export default _default;
-export type { LogicAction };
+import type { GameConfig, GamePreference } from "./gameTypes";
+import { DeepPartial, Hooks, StringKeyOf } from "../../util/data";
+import { LogicAction } from "./action/logicAction";
+import { LiveGame } from "./game/liveGame";
+import { Preference } from "./game/preference";
+import { Plugins, IGamePluginRegistry } from "./game/plugin/plugin";
+import { LayoutRouter } from "../player/lib/PageRouter/router";
+import { KeyMap } from "./game/keyMap";
+declare enum GameSettingsNamespace {
+    game = "game"
+}
+export type GameHooks = {
+    /**
+     * Hook when the game is initialized
+     *
+     * This hook's behavior is similar to the `useEffect` hook in React. It will be called twice when the strict mode is enabled.
+     * It is used to configure the game.
+     */
+    "init": [];
+    /**
+     * Hook when preloading images
+     *
+     * @param src - The source of the image
+     * @param set - Calling this function will set the src and options of the fetch request. This is useful to proxy
+     * - **Note**: "signal" is preserved from the original options
+     */
+    "preloadImage": [src: string, set: (src: string, options?: RequestInit) => void];
+};
+export declare class Game {
+    static GameSettingsNamespace: typeof GameSettingsNamespace;
+    readonly hooks: Hooks<GameHooks>;
+    /**
+     * Game settings
+     */
+    preference: Preference<GamePreference>;
+    /**
+     * Game key bindings
+     */
+    keyMap: KeyMap;
+    /**
+     * Plugin registry
+     */
+    plugins: Plugins;
+    router: LayoutRouter;
+    /**
+     * Create a new game
+     * @param config - Game configuration
+     */
+    constructor(config: DeepPartial<GameConfig>);
+    /**
+     * Configure the game
+     */
+    configure(config: DeepPartial<GameConfig>): this;
+    /**
+     * Configure the game and freeze the fields
+     *
+     * This method is not recommended to be used without using NarraLeaf Engine or Plugin Environment.
+     * @param config - Game configuration
+     */
+    configureAndFreeze(config: DeepPartial<GameConfig>): this;
+    /**
+     * Freeze the fields
+     *
+     * This method is not recommended to be used without using NarraLeaf Engine or Plugin Environment.
+     * @param fields - The fields to freeze
+     */
+    freeze(fields: (StringKeyOf<GameConfig>)[]): this;
+    /**
+     * Use a plugin
+     * @param plugin - The plugin to use
+     */
+    use(plugin: IGamePluginRegistry): this;
+    getLiveGame(): LiveGame;
+    /**
+     * Dispose the game and all its resources
+     *
+     * **Note**: This action is irreversible.
+     */
+    dispose(): void;
+}
+declare const _default: {
+    Game: typeof Game;
+    LiveGame: typeof LiveGame;
+};
+export default _default;
+export type { LogicAction };