keytops-game-framework 1.0.0

package/dist/app/module/config/ConfigHelper.d.ts

@@ -0,0 +1,142 @@
+/**
+ * 数据/配置查询协助工具
+ * @type DataStructure 数据结构
+ */
+export declare abstract class ConfigHelper<DataStructure> {
+    protected _path: string;
+    protected _data: DataStructure;
+    constructor(path?: string);
+    /**
+     * 直接设置数据
+     * @param data
+     * @returns
+     */
+    setData(data: DataStructure): ConfigHelper<DataStructure>;
+    /**
+     * 数据
+     */
+    get data(): DataStructure;
+    /**
+     * 加载配置（需要在子类中实现）
+     * @param onComplete
+     * @param caller
+     * @param path
+     * @returns
+     */
+    abstract loadData(onComplete?: (error: Error, config: ConfigHelper<DataStructure>) => void, caller?: any, path?: string): Promise<ConfigHelper<DataStructure>>;
+    /**
+     * loadData的Promise包装
+     * @returns
+     */
+    load(): Promise<ConfigHelper<DataStructure>>;
+    get path(): string;
+    /**
+     * 获取字段对应的数据
+     * @param key 字段名,支持'att.subatt.subatt...'多层字段
+     * @returns
+     */
+    findData<T>(key: string | number): T;
+    /**
+     * 通过指定条件筛选并返回第一个子项
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 匹配结果为0个的情况下返回Null
+     */
+    firstData<T>(filterKey: string, filterValue: any, subKey?: string | number): T;
+    /**
+     * 通过指定条件筛选并返回最后一个子项
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 匹配结果为0个的情况下返回Null
+     *
+     * 关于顺序：先以升序枚举数值键，然后以插入顺序枚举字符串和符号键
+     */
+    lastData<T>(filterKey: string, filterValue: any, subKey?: string | number): T;
+    /**
+     * 通过指定条件筛选子项. 比如查询道具类型(type)为1的道具列表.比如章节(chapter)为第1章的关卡列表.
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 符合条件的子项数组.
+     */
+    selectData<T>(filterKey: string, filterValue: any, subKey?: string | number): T[];
+    /**
+     * 索引数据位置,-1为不存在
+     * @param value 查找的值
+     * @param key [可选] 子数据字段名,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns -1不存在, >=0为值所在的位置
+     */
+    indexof<T>(value: T, key?: string | number): number;
+    /**
+     * 最后索引数据位置,-1为不存在
+     * @param value 查找的值
+     * @param key [可选] 子数据字段名,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @param fromIndex [可选] 开始检索的索引
+     * @returns -1不存在, >=0为值所在的位置
+     */
+    lastIndexof<T>(value: T, key?: string | number, fromIndex?: number): number;
+    /**
+     * 获取数据数量,取数据的length或者size,可以自定义或者配置为数组
+     * @returns
+     */
+    get size(): number;
+    /**
+     * 获取字段对应的数据
+     * @param data 要查询的数据集
+     * @param key 字段名,支持'att.subatt.subatt...'多层字段
+     * @returns
+     */
+    static findData<T>(data: any, key: string | number): T;
+    /**
+     * 通过指定条件筛选并返回第一个子项
+     * @param data 要查询的数据集
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 匹配结果为0个的情况下返回Null
+     *
+     * 关于顺序：先以升序枚举数值键，然后以插入顺序枚举字符串和符号键
+     */
+    static firstData<T>(data: any, filterKey: string, filterValue: any, subKey?: string | number): T;
+    /**
+     * 通过指定条件筛选并返回最后一个子项
+     * @param data 要查询的数据集
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 匹配结果为0个的情况下返回Null
+     *
+     * 关于顺序：先以升序枚举数值键，然后以插入顺序枚举字符串和符号键
+     */
+    static lastData<T>(data: any, filterKey: string, filterValue: any, subKey?: string | number): T;
+    /**
+     * 通过指定条件筛选子项. 比如查询道具类型(type)为1的道具列表.比如章节(chapter)为第1章的关卡列表.
+     * @param data 要查询的数据集
+     * @param filterKey 子项拥有的字段名
+     * @param filterValue 子项的key字段的值等于value
+     * @param subKey 目标数据路径,支持'att.subatt.subatt...'多层字段, 默认为根数据
+     * @returns 符合条件的子项数组.
+     *
+     * 关于顺序：先以升序枚举数值键，然后以插入顺序枚举字符串和符号键
+     */
+    static selectData<T>(data: any, filterKey: string, filterValue: any, subKey?: string | number): T[];
+    /**
+     * 索引数据位置,-1为不存在
+     * @param data 要查询的数据集
+     * @param value 查找的值
+     * @param key [可选] 子数据字段名,支持'att1.att2.att3...'多层字段, 默认为根数据
+     * @returns -1不存在, >=0为值所在的位置
+     */
+    static indexof<T>(data: any, value: T, key?: string | number): number;
+    /**
+     * 最后索引数据位置,-1为不存在
+     * @param data 要查询的数据集
+     * @param value 查找的值
+     * @param key [可选] 子数据字段名,支持'att1/att2/att3...'多层字段, 默认为根数据
+     * @param fromIndex [可选] 开始检索的索引
+     * @returns -1不存在, >=0为值所在的位置
+     */
+    static lastIndexof<T>(data: any, value: T, key?: string | number, fromIndex?: number): number;
+}

package/dist/app/module/ecs/Component.d.ts

@@ -0,0 +1,125 @@
+import { ComponentType } from "./ECS";
+import { EntityID } from "./Entity";
+/**
+ * 组件接口
+ */
+export interface IComponent {
+    /**
+     * 组件名称,在onCreate中传入设置,无需手动设置
+     */
+    readonly name: string;
+    /**
+     * 组件ID
+     */
+    readonly id: number;
+    /**
+     * 组件类型,在onCreate中传入设置,无需手动设置
+     */
+    readonly type: number;
+    /**
+     * 拥有该组件的实体
+     */
+    readonly entity: EntityID;
+    /**
+     * 释放组件,并存放到缓存中.组件未从entity移除时,什么都不会发生.
+     */
+    release(): void;
+    /**
+     * 组件被创建时
+     * @param type
+     * @param name
+     * @param datas 其他数据
+     */
+    onCreate(type: number, name: string, ...datas: any[]): void;
+    /**
+     * 组件被添加到实体上时调用
+     * @param entity
+     */
+    onAdd(entity: EntityID): void;
+    /**
+     * 组件被移除时调用
+     */
+    onRemove(): void;
+    /**
+     * 组件被释放时调用
+     */
+    onRelease(): void;
+}
+export type ComponentClass = {
+    create<T extends Component>(): T;
+};
+/**
+ * 携带了数据的组件创建类型
+ */
+export type ComponentMate = {
+    clazz: ComponentClass;
+    data?: any[];
+} | ComponentClass;
+/**
+ * 基础组件
+ */
+export declare class Component implements IComponent {
+    private static _componentPool;
+    /**
+     * 创建该组件
+     * @returns
+     */
+    static create<T extends Component>(): T;
+    /**
+     * 释放组件
+     * @param component
+     */
+    protected static release(component: Component): void;
+    private static nextId;
+    /**
+     * 指定创建组件时携带的数据
+     * @param data 数据
+     * @returns
+     */
+    static meta(...data: any[]): ComponentMate;
+    private _id;
+    /**
+     * 组件ID
+     */
+    get id(): number;
+    private _type;
+    /**
+     * 组件类型
+     */
+    get type(): ComponentType;
+    private _name;
+    /**
+     * 组件名称
+     */
+    get name(): string;
+    protected _entity: EntityID;
+    /**
+     * 拥有该组件的实体
+     */
+    get entity(): EntityID;
+    constructor();
+    /**
+     * 组件被创建时
+     * @param type
+     * @param name
+     * @param datas 其他数据
+     */
+    onCreate(type: number, name: string, ...datas: any[]): void;
+    /**
+     * 组件被添加到实体上时调用
+     * @param entity
+     */
+    onAdd(entity: EntityID): void;
+    /**
+     * 组件被移除时调用
+     */
+    onRemove(): void;
+    /**
+     * 释放组件,并存放到缓存中.组件未从entity移除时,什么都不会发生.
+     */
+    release(): void;
+    /**
+     * 组件被释放时调用
+     */
+    onRelease(): void;
+}

package/dist/app/module/ecs/ECS.d.ts

@@ -0,0 +1,162 @@
+import { ComponentClass, IComponent, ComponentMate, Component } from "./Component";
+import { EntityID } from "./Entity";
+import { Mask } from "./Mask";
+import { System, SystemClass } from "./System";
+export type ComponentType = number;
+/**
+ * 注册组件
+ * @returns
+ */
+export declare function component(name?: string): any;
+/**
+ * ECS
+ */
+export declare class ECS {
+    private _name;
+    private _running;
+    private _frameCount;
+    private _entityCount;
+    private _systemCount;
+    private _entities;
+    private _components;
+    private _systems;
+    get name(): string;
+    /**
+     * 是否在运行中
+     */
+    get isRunning(): boolean;
+    constructor(name: string);
+    /**
+     * 开始ECS的主循环
+     */
+    launch(): void;
+    private _tick;
+    /**
+     * 停止ECS
+     */
+    shutdown(): void;
+    /**
+     * 停止并重置ECS
+     */
+    reset(): void;
+    private _getComponentMapOfType;
+    /**
+     * 创建实体
+     * @param components 实体所附带的若干组件
+     * @returns 返回实体ID
+     */
+    createEntity(...components: ComponentMate[]): EntityID;
+    /**
+     * 创建实体
+     * @param components
+     */
+    createEntity(...components: ComponentMate[]): EntityID;
+    /**
+     * 释放实体,同时会销毁相关Component
+     * @param entityId 实体ID
+     * @returns
+     */
+    releaseEntity(entityId: EntityID): boolean;
+    /**
+    * 通过掩码查询实体
+    * @param mask
+    */
+    getEntities(mask: Mask): EntityID[];
+    /**
+    * 通过组件匹配查询实体
+    * @param components
+    * @returns
+    */
+    getEntities(component: {
+        new (): IComponent;
+    }, ...components: {
+        new (): IComponent;
+    }[]): EntityID[];
+    /**
+     * 添加组件到实体
+     * @param entityId 实体ID
+     * @param component 组件Class
+     * @param data 若干个组件数据
+     */
+    addComponents<T extends Component>(entityId: EntityID, component: ComponentMate): T | null;
+    /**
+     * 添加组件到实体
+     * @param entityId 实体ID
+     * @param components 一个或多个组件
+     */
+    addComponents(entityId: EntityID, ...components: ComponentMate[]): Component[] | null;
+    /**
+     * 添加组件到实体
+     * @param entityId 实体ID
+     * @param clazz 组件class
+     * @param datas 组件数据
+     * @returns
+     */
+    private _addComponent;
+    /**
+     * 添加组件对象到实体,可用于外部引擎自动实例化的组件.
+     * @param entityId 实体ID
+     * @param component 组件对象
+     * @param datas 传到组件onCreate函数的的参数列表
+     */
+    addComponent(entityId: EntityID, component: IComponent, ...datas: any[]): void;
+    /**
+     * 移除实体的组件
+     * @param component 组件对象
+     */
+    removeComponent(component: IComponent): IComponent;
+    /**
+     * 批量移除实体的组件
+     * @param components 若干个组件对象
+     */
+    removeComponent(...components: IComponent[]): IComponent[];
+    /**
+     * 移除实体的组件
+     * @param entityId 组件ID
+     * @param componentClass 组件class
+     */
+    removeComponentWithClass(entityId: EntityID, componentClass: ComponentClass): IComponent;
+    /**
+     * 批量移除实体的组件
+     * @param entityId 组件ID
+     * @param componentClasses 组件Class列表
+     */
+    removeComponentWithClass(entityId: EntityID, ...componentClasses: ComponentClass[]): IComponent[];
+    /**
+     * 实体是否包含组件mask
+     * @param mask 组件mask
+     */
+    containComponent(entityId: EntityID, mask: Mask): boolean;
+    /**
+     * 实体是否包含组件
+     * @param components 系列组件,全部包含才返回true.
+     */
+    containComponent(entityId: EntityID, ...components: ComponentClass[]): boolean;
+    /**
+     * 获取实体组件
+     * @param componentClass 组件class
+     * @returns `T` or `null`
+     */
+    getComponent<T extends IComponent>(entityId: EntityID, componentClass: ComponentClass | {
+        new (): IComponent;
+    }): T | null;
+    /**
+     * 获取指定类型的所有组件
+     * @param type
+     * @returns
+     */
+    getComponents<T extends IComponent>(componentClass: ComponentClass | {
+        new (): IComponent;
+    }): T[];
+    /**
+     * 添加系统
+     * @param systems 若干系统Class
+     */
+    addSystem(...systems: SystemClass[]): void;
+    /**
+     * 移除系统
+     * @param system
+     * @returns
+     */
+    removeSystem(system: System): boolean;
+}

package/dist/app/module/ecs/ECSManager.d.ts

@@ -0,0 +1,56 @@
+import { ECS } from "./ECS";
+/**
+ * 注册系统
+ * @param ecsName 系统所属的ECS名称
+ * @returns
+ */
+export declare function system(ecsName?: string): any;
+declare class ECSManager {
+    private _ecss;
+    private static created;
+    constructor();
+    /**
+     * 现存的ECS数量
+     */
+    get count(): number;
+    /**
+     * 是否存在ECS
+     * @param name ECS名称
+     * @returns
+     */
+    has(name: string): boolean;
+    /**
+     * 获取ECS
+     * @param name
+     * @returns
+     */
+    get(name: string): ECS | undefined;
+    /**
+     * 获取现存的ECS
+     * @returns
+     */
+    getAll(): ECS[];
+    /**
+     * 创建ECS
+     * @param name ECS名称,默认为default
+     * @returns
+     */
+    create(name?: string): ECS;
+    /**
+     * 释放ECS
+     * @param ecs ECS对象
+     */
+    release(ecs: ECS): boolean;
+    /**
+     * 销毁ECS
+     * @param name ECS名称
+     */
+    release(name: string): boolean;
+    private _releaseByName;
+    private _release;
+}
+/**
+ * ECS管理器
+ */
+export declare const manager: ECSManager;
+export {};

package/dist/app/module/ecs/Entity.d.ts

@@ -0,0 +1 @@
+export type EntityID = number;

package/dist/app/module/ecs/Mask.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 掩码
+ */
+export declare class Mask {
+    private _mask;
+    constructor();
+    set(type: number): void;
+    unset(type: number): void;
+    has(type: number): boolean;
+    has(otherMask: Mask): boolean;
+    clear(): void;
+}

package/dist/app/module/ecs/System.d.ts

@@ -0,0 +1,54 @@
+import { ECS } from "./ECS";
+export type SystemClass = {
+    new (ecs: ECS): System;
+};
+/**
+ * ECS 系统基类
+ */
+export declare abstract class System {
+    /**
+     * 系统优先级，数字越大越优先执行，默认为0
+     */
+    priority: number;
+    /**
+     * 系统运行的条件，默认为无限制运行
+     */
+    condition(frameCount: number): boolean;
+    /**
+     * 系统运行的频率，指定了每隔几帧运行一次，默认为1，表示每帧都运行
+     */
+    frequency: number;
+    /**
+     * 系统是否已经启动
+     */
+    protected _isRunning: boolean;
+    /**
+     * 系统所属的ECS实例
+     */
+    protected _ecs: ECS | null;
+    constructor(ecs: ECS);
+    /**
+     * 启动系统
+     */
+    start(): void;
+    /**
+     * 停止系统
+     */
+    stop(): void;
+    /**
+     * 系统是否正在运行中
+     */
+    get isRunning(): boolean;
+    /**
+     * 系统开始的调用
+     */
+    protected abstract onStart?(): void;
+    /**
+     * 系统结束的调用
+     */
+    protected abstract onStop?(): void;
+    /**
+     * 系统更新的调用
+     */
+    abstract onUpdate(deltaTime: number): void;
+}

package/dist/app/module/fsm/Fsm.d.ts

@@ -0,0 +1,44 @@
+import { IRecoverable } from "../../base/pool/IRecoverable";
+import { FsmBase } from "./FsmBase";
+import { IFsm } from "./IFsm";
+import { IFsmState } from "./IFsmState";
+/**
+ * 有限状态机
+ * @type 有限状态机持有者类型
+ */
+export declare class Fsm<OwnerT, DataT> extends FsmBase implements IFsm<OwnerT, DataT>, IRecoverable {
+    private static pool;
+    protected _owner: OwnerT | null;
+    protected _states: Map<string, IFsmState<OwnerT, DataT>>;
+    protected _data: DataT;
+    protected _currentSate: IFsmState<OwnerT, DataT> | null;
+    protected _currentStateTime: number;
+    protected _isDestroyed: boolean;
+    constructor();
+    get ownerType(): string;
+    protected _tick(dt: number): void;
+    get owner(): OwnerT | null;
+    get fmsStateCount(): number;
+    get isRunning(): boolean;
+    get isDestroyed(): boolean;
+    get currentState(): IFsmState<OwnerT, DataT> | null;
+    get currentStateTime(): number;
+    get currentStateName(): string;
+    /**
+     * 创建有限状态机
+     * @param name 有限状态机名称
+     * @param owner 有限状态机持有者
+     * @param states 有限状态机集合
+     * @returns 创建的有限状态机
+     */
+    static create<T, DataT>(name: string, owner: T, states: IFsmState<T, DataT>[], data?: DataT): Fsm<T, DataT>;
+    start(stateName: string): void;
+    hasState(stateName: string): boolean;
+    getState<T extends IFsmState<OwnerT, DataT>>(stateName: string): T | undefined;
+    getAllStates(): IFsmState<OwnerT, DataT>[];
+    changeState(stateName: string): void;
+    get data(): DataT;
+    shutdown(): void;
+    reset(): void;
+    destroy(): void;
+}

package/dist/app/module/fsm/FsmBase.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 有限状态机基类
+ */
+export declare abstract class FsmBase {
+    protected _name: string;
+    get name(): string;
+    get fullName(): string;
+    abstract readonly ownerType: string;
+    /**
+     * 有限状态机更新
+     * @param dt 间隔时间(秒)
+     */
+    protected abstract _tick(dt: number): void;
+    /**
+     * 开启有限状态机
+     * @param stateName
+     */
+    abstract start(stateName: string): void;
+    /**
+     * 关闭并清理有限状态机
+     */
+    abstract shutdown(): void;
+    abstract readonly fmsStateCount: number;
+    abstract readonly isRunning: boolean;
+    abstract readonly isDestroyed: boolean;
+    abstract readonly currentStateTime: number;
+    abstract readonly currentStateName: string;
+}

package/dist/app/module/fsm/FsmManager.d.ts

@@ -0,0 +1,67 @@
+import { FsmBase } from "./FsmBase";
+import { IFsm } from "./IFsm";
+import { IFsmState } from "./IFsmState";
+/**
+ * 有限状态机管理器
+ */
+declare class FsmManager {
+    private static created;
+    constructor();
+    private _fsms;
+    /**
+     * 获取有限状态机数量
+     */
+    get count(): number;
+    /**
+     * 是否存在有限状态机
+     * @param name 有限状态机名称
+     * @returns
+     */
+    hasFsm(name: string): boolean;
+    /**
+     * 根据名称获取有限状态机
+     * @param name 有限状态机名称
+     * @returns
+     */
+    getFsm<T extends FsmBase>(name: string): T;
+    /**
+     * 获取所有存在的Fsm
+     * @returns
+     */
+    getAllFsms(): FsmBase[];
+    /**
+     * 创建一个有限状态机
+     * @param owner 有限状态机拥有者
+     * @param states 状态列表
+     * @param name 有限状态机名称,默认:default
+     * @returns
+     */
+    createFsm<OwnerT, DataT>(owner: OwnerT, states: IFsmState<OwnerT, DataT>[], name?: string, data?: DataT): IFsm<OwnerT, DataT>;
+    /**
+     * 销毁有限状态机
+     * @param fsmName
+     * @returns
+     */
+    destroyFsmByName(fsmName: string): boolean;
+    /**
+     * 销毁有限状态机
+     * @param fsm 状态机
+     * @returns
+     */
+    destroyFsm(fsm: FsmBase): boolean;
+    /**
+     * 销毁有限状态机
+     * @param owner 有限状态机持有者
+     * @returns
+     */
+    destroyFsmByOwner(owner: any): boolean;
+    /**
+     * 关闭并清理有限状态机管理器
+     */
+    shutdown(): void;
+}
+/**
+ * 有限状态机管理器
+ */
+export declare const fsmManager: FsmManager;
+export {};