hzengine-core 0.1.2-dev

package/types/storage/index.d.ts

@@ -0,0 +1,86 @@
+import { HZEngineCore } from "../index.js";
+export declare class Storage {
+    private _core;
+    constructor(_core: HZEngineCore);
+    projectRoot: string | null;
+    cacheRoot: string | null;
+    saveRoot: string | null;
+    preloadedData: NonNullable<any> | null;
+    packageData: NonNullable<any> | null;
+    loadProject(options: {
+        projectPath: string;
+        cachePath: string;
+        savePath: string;
+    }): void;
+    loadPackageData(): void;
+    /**
+     * 全局数据
+     * 其中的数据不会跟随存档保存，而是直接存储在全局数据文件中
+     * 如：设置、CG解锁情况等
+     */
+    private _globalData;
+    get globalData(): NonNullable<Storage.JSONValue>;
+    /**
+     * alias globalData
+     */
+    get gd(): NonNullable<Storage.JSONValue>;
+    /**
+     * 存档数据
+     * 其中的数据会跟随存档保存
+     * 如：脚本执行位置即调用栈，攻略度等
+     */
+    private _archiveData;
+    get archiveData(): NonNullable<Storage.JSONValue>;
+    /**
+     * alias archiveData
+     */
+    get sd(): NonNullable<Storage.JSONValue>;
+    loadGlobalData(): void;
+    /**
+     * 保存全局数据
+     * 可以多次調用，實際上會異步儲存，也就是在一個宏任務中即使調用多次，也只會在宏任務結束後儲存一次
+     */
+    private _saveGlobalDataTimerId;
+    saveGlobalData(): void;
+    loadArchiveData(archiveFile?: string): void;
+    _saveArchiveDataTimerId: number | null;
+    /**
+     * 保存存档数据
+     * 可以多次調用，實際上會異步儲存，也就是在一個宏任務中即使調用多次，也只會在宏任務結束後儲存一次
+     * @param archiveFile 存档文件目錄及名字
+     */
+    saveArchiveData(archiveFile: string, immediate?: boolean): void;
+    getSaveableData(data: Storage.JSONValue, auto_correct: boolean, ...key_chain: string[]): NonNullable<Storage.JSONValue>;
+    setSaveableData(data: Storage.JSONValue, auto_correct: boolean, value: Storage.JSONValue, ...key_chain: string[]): void;
+    checkSaveableData(data: Storage.JSONValue, ...key_chain: string[]): NonNullable<Storage.JSONValue>;
+    preload(): void;
+    /**
+     * 预加载脚本
+     * 遍历出所有hzs文件和所有label，建立map
+     */
+    preloadScript(): void;
+    /**
+     * 预加载资源
+     * 遍历所有png文件，计算对应的name key，建立map
+     */
+    preloadImage(): void;
+    /**
+     * 預加載動畫profile
+     * 遍歷animation文件夾下的所有json文件，以文件名為key，json内容為value
+     */
+    preloadAnimation(): void;
+}
+export declare type HzsInfo = {
+    totalLines: number;
+};
+export declare namespace Storage {
+    export type JSONBaseType = number | string | boolean | null;
+    export type JSONValue = JSONBaseType | {
+        [key: string]: JSONValue;
+    } | JSONValue[];
+    export type Saveable<T> = {
+        [P in keyof T]: T[P] extends JSONValue ? T[P] : T[P] extends NotAssignableToJson ? never : Saveable<T[P]>;
+    } | JSONValue[] | JSONValue;
+    type NotAssignableToJson = bigint | symbol | Function;
+    export {};
+}

package/types/system/index.d.ts

@@ -0,0 +1,35 @@
+import { HZEngineCore, Platform } from "../index.js";
+export declare class System<PlatformType extends Platform> {
+    _core: HZEngineCore<PlatformType>;
+    constructor(_core: HZEngineCore<PlatformType>);
+    accessor condition: System.Condition;
+    _pauseTimer: number | null;
+    /**
+     * 暂停(可指定一段时间)
+     * 后调用的会覆盖之前pause的设定时间
+     * @param delayMs
+     */
+    pause(delayMs?: number): void;
+    /**
+     * 继续由于pause中断的游戏
+     */
+    continue(): void;
+    /**
+     * 阻塞
+     */
+    block(): void;
+    /**
+     * 取消阻塞
+     */
+    unBlock(): void;
+    run(): void;
+    start(initLabel?: string): void;
+}
+export declare namespace System {
+    enum Condition {
+        Free = 0,
+        Pause = 1,
+        Blocked = 2,
+        Gaming = 3
+    }
+}

package/types/ui/index.d.ts

@@ -0,0 +1,167 @@
+import { HZEngineCore, Platform } from "../index.js";
+import { Storage } from "../storage/index.js";
+export declare class UI<PlatformType extends Platform = any> {
+    _core: HZEngineCore<PlatformType>;
+    constructor(_core: HZEngineCore<PlatformType>);
+    private _initUI;
+    private _cleanUI;
+    resetUI(): void;
+    private accessor _layerList;
+    get layerList(): Map<string, UI.Layer<PlatformType>>;
+    addLayer(name: string, z_index: number): void;
+    getLayer(name: string): UI.Layer<PlatformType> | undefined;
+    private _viewClassMap;
+    registerView<PropType extends Storage.Saveable<PropType>>(name: string, cls: UI.ViewClass<PropType, PlatformType>): void;
+    private accessor _nextViewId;
+    private accessor _viewMap;
+    getView(id: number): UI.View<Storage.Saveable<unknown>, PlatformType> | null;
+    createView<PropType extends Storage.Saveable<PropType>>(name: string, layer: string, prop: PropType, isSave: boolean): UI.View<PropType, PlatformType>;
+    updateView<PropType extends Storage.Saveable<PropType>>(viewInstance: UI.View<PropType, PlatformType>, new_prop: PropType): void;
+    destroyView(viewInstance: UI.View<Storage.Saveable<unknown>, PlatformType>): void;
+    /**由調用者提供id，創建一個View，不會處理isSave，也不會更新viewMap */
+    private _produceViewWithId;
+    private accessor _routerMap;
+    getRouter(tag: string): UI.Router<PlatformType> | undefined;
+    addRouter(tag: string, layer: string, isSave?: boolean): UI.Router<PlatformType>;
+    getScreenSize(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * 根据 BasicUniversalProp 计算屏幕上的位置
+     * @param prop 包含 BasicUniversalProp 的 prop
+     * @param size (可选)图像的尺寸，若不指定，返回的anchor坐标和origin坐标一样
+     * @returns
+     */
+    calcPosition(prop: UI.BasicUniversalProp, size?: UI.Size): {
+        /** 锚点（算上偏移）的屏幕位置 */
+        anchor: UI.Coordinate;
+        /** 图像左上角的屏幕位置 */
+        origin: UI.Coordinate;
+    };
+}
+export declare namespace UI {
+    type ViewClass<PropType extends Storage.Saveable<PropType>, PlatformType extends Platform> = {
+        new (layer: string, core: HZEngineCore<PlatformType>): View<PropType, PlatformType>;
+    };
+    abstract class View<PropType extends Storage.Saveable<PropType>, PlatformType extends Platform = any> {
+        layer: string;
+        core: HZEngineCore<PlatformType>;
+        id: number | null;
+        name: string | null;
+        isSave: boolean;
+        private _prop;
+        get prop(): PropType | null;
+        private set prop(value);
+        constructor(layer: string, core: HZEngineCore<PlatformType>);
+        create(prop: PropType): void;
+        protected abstract onCreate(prop: PropType): void;
+        commit(prop: PropType): void;
+        protected abstract onCommit(prop: PropType): void;
+        destroy(): void;
+        protected abstract onDestroy(): void;
+        serialize(): View.Serialized;
+    }
+    namespace View {
+        interface Serialized {
+            name: string;
+            layer: string;
+            prop: Storage.Saveable<unknown>;
+        }
+    }
+    interface BasicUniversalProp {
+        alpha?: number;
+        xalign?: number;
+        yalign?: number;
+        xanchor?: number;
+        yanchor?: number;
+        xoffset?: number;
+        yoffset?: number;
+    }
+    interface Message {
+        who: string;
+        what: string;
+    }
+    abstract class MessageView<PlatformType extends Platform> extends View<Message, PlatformType> {
+    }
+    interface MenuItemData {
+        text: string;
+        position: [path: string, index: number];
+        enable_js_expression?: string;
+    }
+    type MenuViewProp = {
+        itemList: MenuItemData[];
+    };
+    abstract class MenuView<PlatformType extends Platform> extends View<MenuViewProp, PlatformType> {
+    }
+    type Coordinate = {
+        x: number;
+        y: number;
+    };
+    type Size = {
+        width: number;
+        height: number;
+    };
+    /**
+     * 立绘/道具等显示在`fg`layer上的图片View
+     */
+    type FgImgViewProp = {
+        imgPath: string;
+        offset: Coordinate;
+        size: Size;
+    };
+    abstract class FgImgView<PlatformType extends Platform> extends View<FgImgViewProp, PlatformType> {
+    }
+    /**
+     * cg等显示在`bg`layer上的图片View
+     */
+    type BgImgViewProp = {
+        imgPath: string;
+        offset: Coordinate;
+        size: Size;
+    };
+    abstract class BgImgView<PlatformType extends Platform> extends View<FgImgViewProp, PlatformType> {
+    }
+    class Layer<PlatformType extends Platform> {
+        _core: HZEngineCore<PlatformType>;
+        name: string;
+        z_index: number;
+        widgetFactory: ReturnType<PlatformType["createUILayer"]>;
+        constructor(_core: HZEngineCore<PlatformType>, name: string, z_index: number);
+        destroy(): void;
+    }
+    namespace Layer {
+    }
+    class Router<PlatformType extends Platform> {
+        private _ui;
+        tag: string;
+        layer: string;
+        isSave: boolean;
+        constructor(_ui: UI<PlatformType>, tag: string, layer: string, isSave?: boolean);
+        serialize(): Router.Serialized;
+        defaultRouteStrategy: Router.RouteStrategy;
+        static deserialize<PlatformType extends Platform>(ui: UI<PlatformType>, data: Router.Serialized): Router<PlatformType>;
+        viewStack: [view_name: string, prop: Storage.Saveable<unknown>][];
+        get length(): number;
+        activeViewInstance: View<Storage.Saveable<unknown>, PlatformType> | null;
+        push<T extends Storage.Saveable<T>>(view_name: string, prop: T, strategy?: Router.RouteStrategy): void;
+        pop<T extends Storage.Saveable<T>>(back_prop?: T, strategy?: Router.RouteStrategy): void;
+        replace<T extends Storage.Saveable<T>>(view_name: string, prop: T, strategy?: Router.RouteStrategy): void;
+        update<T extends Storage.Saveable<T>>(prop: T, strategy?: Router.RouteStrategy): void;
+        clear(strategy?: Router.RouteStrategy): void;
+    }
+    namespace Router {
+        interface Serialized {
+            tag: string;
+            layer: string;
+            isSave: boolean;
+            viewStack: [view_name: string, prop: Storage.Saveable<unknown>][];
+            activeViewId: number | null;
+        }
+        interface RouteStrategy<PropType extends Storage.Saveable<PropType> = Storage.Saveable<unknown>, PlatformType extends Platform = any> {
+            destroy?(viewInstance: View<PropType, PlatformType>, ui: UI<PlatformType>): void;
+            create?(viewName: string, layer: string, prop: PropType, ui: UI<PlatformType>, isSave: boolean): View<Storage.Saveable<PropType>, PlatformType>;
+            update?(viewInstance: View<PropType, PlatformType>, prop: PropType, ui: UI<PlatformType>): void;
+        }
+    }
+}

package/types/utils/path.d.ts

@@ -0,0 +1,84 @@
+export default posix;
+declare namespace posix {
+    /**
+     * 解析路径，将相对路径转换为绝对路径
+     * @param {...string} paths - 要解析的路径
+     * @returns {string} - 解析后的绝对路径
+     */
+    function resolve(...args: string[]): string;
+    /**
+     * 规范化路径，去除多余的斜杠和当前目录
+     * @param {string} path - 输入的路径字符串
+     * @returns {string} - 规范化后的路径
+     */
+    function normalize(path: string): string;
+    /**
+     * 检查路径是否为绝对路径
+     * @param {string} path - 输入的路径字符串
+     * @returns {boolean} - 如果路径为绝对路径，则返回 true
+     */
+    function isAbsolute(path: string): boolean;
+    /**
+     * 连接多个路径段为一个路径
+     * @param {...string} segments - 要连接的路径段
+     * @returns {string} - 连接后的路径
+     */
+    function join(...args: string[]): string;
+    /**
+     * 计算相对路径
+     * @param {string} from - 起始路径
+     * @param {string} to - 目标路径
+     * @returns {string} - 相对路径
+     */
+    function relative(from: string, to: string): string;
+    /**
+     * 获取路径的目录名
+     * @param {string} path - 输入的路径字符串
+     * @returns {string} - 目录名
+     */
+    function dirname(path: string): string;
+    /**
+     * 获取路径的基本名
+     * @param {string} path - 输入的路径字符串
+     * @param {string} [ext] - 可选的扩展名，如果提供则将其从基本名中去除
+     * @returns {string} - 基本名
+     */
+    function basename(path: string, ext?: string | undefined): string;
+    /**
+     * 获取路径的扩展名
+     * @param {string} path - 输入的路径字符串
+     * @returns {string} - 扩展名
+     */
+    function extname(path: string): string;
+    /**
+     * 格式化路径对象为路径字符串
+     * @param {Object} pathObject - 路径对象
+     * @param {string} pathObject.root - 根路径
+     * @param {string} pathObject.dir - 目录路径
+     * @param {string} pathObject.base - 基本文件名
+     * @param {string} pathObject.ext - 扩展名
+     * @param {string} pathObject.name - 文件名（不包含扩展名）
+     * @returns {string} - 格式化后的路径字符串
+     */
+    function format(pathObject: {
+        root: string;
+        dir: string;
+        base: string;
+        ext: string;
+        name: string;
+    }): string;
+    /**
+     * 解析路径字符串为路径对象
+     * @param {string} pathString - 输入的路径字符串
+     * @returns {{root: string, dir: string, base: string, ext: string, name: string}} - 路径对象
+     */
+    function parse(pathString: string): {
+        root: string;
+        dir: string;
+        base: string;
+        ext: string;
+        name: string;
+    };
+    let sep: string;
+    let delimiter: string;
+}