keytops-game-framework 1.0.0

package/dist/app/module/structure/Dictionary.d.ts

@@ -0,0 +1,48 @@
+import { EventDispatcher } from "../../base/event/EventDispatcher";
+declare enum EventType {
+    ADD = "DictionaryEventType.ADD",
+    REMOVE = "DictionaryEventType.REMOVE",
+    UPDATE = "DictionaryEventType.UPDATE"
+}
+/**
+ * 字典
+ */
+export declare class Dictionary<K, V> extends EventDispatcher {
+    static EventType: typeof EventType;
+    private _map;
+    get count(): number;
+    constructor();
+    set(key: K, value: V): void;
+    /**
+     * 是否拥有指定KEY的元素
+     * @param key
+     * @returns
+     */
+    has(key: K): boolean;
+    /**
+     * 获取指定元素
+     * @param key
+     * @returns
+     */
+    get(key: K): V;
+    /**
+     * 删除指定元素
+     * @param key
+     * @returns
+     */
+    delete(key: K): V | null;
+    /**
+     * 清除所有元素
+     */
+    clear(): void;
+    private _cacheElements;
+    /**
+    * 元素列表
+    */
+    get elements(): Array<V>;
+    /**
+     * key列表
+     */
+    get keys(): Array<K>;
+}
+export {};

package/dist/app/module/structure/Link.d.ts

@@ -0,0 +1,149 @@
+/**
+ * 模块化的数据链，方便数据扩展（组合优于继承）
+ *
+ */
+export declare abstract class Link<DataStruct> {
+    private _event;
+    protected _linkName: string;
+    protected _parent: Link<any>;
+    protected _children: Map<string, Link<any>>;
+    protected _data: DataStruct;
+    constructor(linkName: string, data: DataStruct);
+    /**
+     * 获取父级
+     */
+    get parent(): Link<any>;
+    /**
+     * 设置父级对象，值为null时，从父级移除。
+     */
+    set parent(value: Link<any>);
+    get linkName(): string;
+    /**
+     * 所有下级
+     */
+    get children(): Link<any>[];
+    /**
+     * 获取指定名称子项，更便捷的方式 linkObject.name
+     * @param name 子项名称
+     * @returns
+     */
+    child<T extends Link<any>>(name: string): T;
+    /**
+     * 下级数量
+     */
+    get childrenCount(): number;
+    /**
+     * 链接下级
+     * @param types 一个或多个下一级的Class
+     */
+    append(...types: {
+        new (): Link<any>;
+    }[]): Link<any>;
+    /**
+     * 链接下级
+     * @param links 一个或多个下一级的对象
+     */
+    append(...links: Link<any>[]): Link<any>;
+    private _appendChild;
+    private _onEvents;
+    private _offEvents;
+    protected _onChildAppend(child: Link<any>, parent: Link<any>): void;
+    protected _onChildSubtract(child: Link<any>, parent: Link<any>): void;
+    protected _onChildUpdate(name: string, newValue: any, target: Link<any>, oldValue: any): void;
+    /**
+     * 移除下级，更快捷的方式linkObject.name = null;
+     * @param name 下级名称
+     * @param destory 是否销毁下级，默认为true
+     */
+    subtract(name: string, destory?: boolean): boolean;
+    /**
+     * 移除下级，更快捷的方式linkObject.name = null;或者target.parent = null;
+     * @param target 下级对象
+     * @param destory 是否销毁下级，默认为true
+     */
+    subtract(target: Link<any>, destory?: boolean): boolean;
+    /**
+     * 数据更新后的通知
+     * @param newValue 新设置的值
+     * @param oldValue 原先的值
+     */
+    protected updated<T>(name: string, newValue: T, oldValue: T, ...args: any[]): void;
+    /**
+     * 重置数据
+     * @param children 是否同时重置所有子项的数据
+     */
+    reset(children?: boolean): void;
+    /**
+     * 重置自身数据
+     */
+    protected abstract _restSelfData(): void;
+    /**
+     * 销毁
+     */
+    destory(): void;
+    /**
+     * 解析字符串或序列化Object并填充到自身及所有子项数据
+     * @param value
+     */
+    parse(value: string | Object): void;
+    /**
+      * 转换自身及所有子项数据为字符串。字符串格式：`{data:{key:value},child:{childname:{data:key:value,child:{...}}, ...}}`
+      */
+    toString(): string;
+    toObject(): object;
+    /**
+* 添加子项增加的监听
+* @param caller
+* @param listener
+* @param args
+*/
+    onChildAppended(caller: any, listener: (child?: Link<any>, parent?: Link<any>) => void, ...args: any[]): void;
+    /**
+     * 移除子项添加监听
+     * @param caller
+     * @param listener
+     */
+    offChildAppended(caller: any, listener: (child?: Link<any>, parent?: Link<any>) => void): void;
+    /**
+     * 添加移除子项的监听
+     * @param caller
+     * @param listener
+     * @param args
+     */
+    onChildSubtracted(caller: any, listener: (child?: Link<any>, parent?: Link<any>) => void, ...args: any[]): void;
+    /**
+     * 移除子项移除的监听
+     * @param caller
+     * @param listener
+     */
+    offChildSubtracted(caller: any, listener: (child?: Link<any>, parent?: Link<any>) => void): void;
+    /**
+     * 添加更新（包括子项）的监听
+     * @param caller
+     * @param listener
+     * @param args
+     */
+    onUpdated(caller: any, listener: (name?: string, newValue?: any, target?: Link<any>, oldValue?: any, ...args: any[]) => void, ...args: any[]): void;
+    /**
+     * 移除更新的监听
+     * @param caller
+     * @param listener
+     */
+    offUpdated(caller: any, listener: (name?: string, newValue?: any, target?: Link<any>, oldValue?: any) => void): void;
+    /**
+     * 移除监听者下的所有监听
+     * @param caller
+     */
+    offAllByCaller(caller: any): void;
+    /**
+     * 移除所有监听
+     */
+    offAll(): void;
+}
+/**
+ * 空白link
+ */
+export declare class EmptyLink extends Link<void> {
+    constructor(name: string);
+    protected _restSelfData(): void;
+}

package/dist/app/module/structure/List.d.ts

@@ -0,0 +1,93 @@
+import { EventDispatcher } from "../../base/event/EventDispatcher";
+declare enum Event {
+    ADD = "LIST.EVENT.ADD",
+    REMOVE = "LIST.EVENT.REMOVE",
+    UPDATE = "LIST.EVENT.UPDATE",
+    CLEAR = "LIST.EVENT.CLEAR"
+}
+/**
+ * 列表
+ */
+export declare class List<T> extends EventDispatcher {
+    static Event: typeof Event;
+    private _arr;
+    /**
+     * 是否保证元素的唯一性
+     */
+    private _only;
+    /**
+     * 长度，建议通过length属性获取
+     * @deprecated
+     */
+    get count(): number;
+    /**
+     * 长度
+     *
+     */
+    get length(): number;
+    /**
+     *
+     * @param only 确保数据的唯一性
+     */
+    constructor(only?: boolean);
+    /**
+     * 添加到末尾(注意如果保证唯一性，那么重复时就直接返回)
+     * @param value
+     */
+    push(value: T): boolean;
+    /**
+     * 添加到列表头部(注意如果保证唯一性，那么重复时就直接返回)
+     * @param value
+     * @returns
+     */
+    unshift(value: T): boolean;
+    /**
+     * 获取并删除最后一个元素
+     * @returns
+     */
+    pop(): T | null | undefined;
+    /**
+     * 获取并删除第一个元素
+     * @returns
+     */
+    shift(): T | null | undefined;
+    /**
+     * 删除指定索引的元素
+     * @param index
+     */
+    removeAt(index: number): T | null;
+    /**
+     * 删除元素
+     * @param value
+     */
+    remove(value: T): void;
+    /**
+     * 移除所有元素
+     */
+    clear(): void;
+    /**
+     * 查找元素
+     * @param value
+     * @returns
+     */
+    find(predicate: (value: T, index: number, obj: T[]) => unknown): T | undefined;
+    /**
+     * 查找元素下标
+     * @param value
+     * @returns
+     */
+    indexOf(value: T, fromIndex?: number): number;
+    /**
+     * 查找元素下标
+     * @param predicate
+     * @returns
+     */
+    findIndex(predicate: (value: T, index: number, obj: T[]) => unknown): number;
+    /**
+     * 获取指定元素
+     * @param index
+     * @returns
+     */
+    get(index: number): T | null;
+}
+export {};

package/dist/app/module/task/Task.d.ts

@@ -0,0 +1,33 @@
+import { EventDispatcher } from "../../base/event/EventDispatcher";
+import { IRecoverable } from "../../base/pool/IRecoverable";
+declare enum Event {
+    START = "TASK.EVENT.START",
+    PROGRESS = "TASK.EVENT.PROGRESS",
+    COMPLETE = "TASK.EVENT.COMPLETE",
+    ERROR = "TASK.EVENT.ERROR"
+}
+/**
+ * 任务处理
+ */
+export declare class Task extends EventDispatcher implements IRecoverable {
+    static Event: typeof Event;
+    protected _percent: number;
+    /**
+     * 开始
+     * @param data
+     */
+    start(...data: any): void;
+    /** 规范事件抛出格式，供内外部调用 */
+    onStart(): void;
+    onComplete(): void;
+    onError(code: string, msg: string): void;
+    onProgress(percent: number): void;
+    /** 规范事件抛出格式，供内外部调用 */
+    get percent(): number;
+    reset(): void;
+    /**
+     * 销毁
+     */
+    destroy(): void;
+}
+export {};

package/dist/app/module/task/TaskQueue.d.ts

@@ -0,0 +1,17 @@
+import { IRecoverable } from "../../base/pool/IRecoverable";
+import { Task } from "./Task";
+/**
+ * 任务序列（并行）
+ */
+export declare class TaskQueue extends Task implements IRecoverable {
+    private _taskMap;
+    private _index;
+    constructor();
+    addQuickly(taskCaller: any, taskFun: (task: Task, ...taskData: any[]) => void, ...taskData: any[]): Task;
+    addTask(value: Task, ...data: any[]): void;
+    removeTask(value: Task): boolean;
+    start(...data: any): void;
+    private _subTaskEventHandler;
+    reset(): void;
+    destroy(): void;
+}

package/dist/app/module/task/TaskSequence.d.ts

@@ -0,0 +1,19 @@
+import { IRecoverable } from "../../base/pool/IRecoverable";
+import { Task } from "./Task";
+/**
+ * 任务队列
+ */
+export declare class TaskSequence extends Task implements IRecoverable {
+    private _taskMap;
+    private _keys;
+    private _index;
+    constructor();
+    addQuickly(taskCaller: any, taskFun: (task: Task, ...taskData: any[]) => void, ...taskData: any[]): Task;
+    addTask(value: Task, ...data: any[]): void;
+    removeTask(value: Task): boolean;
+    start(...data: any): void;
+    private _tryNext;
+    private _subTaskEventHandler;
+    reset(): void;
+    destroy(): void;
+}

package/dist/app/module/timer/ITimer.d.ts

@@ -0,0 +1,4 @@
+import { Timer } from "./Timer";
+export interface ITimer {
+    enable(timer: Timer): void;
+}

package/dist/app/module/timer/Timer.d.ts

@@ -0,0 +1,133 @@
+/**
+ * <code>Timer</code> 是时钟管理类。它是一个单例，不要手动实例化此类，应该通过 Laya.timer 访问。
+ */
+export declare class Timer {
+    static KEY: string;
+    private static _gid;
+    /**@private */
+    private static _pool;
+    /**@private */
+    static _mid: number;
+    /** 时针缩放。*/
+    scale: number;
+    /** 当前帧开始的时间。*/
+    currTimer: number;
+    /** 当前的帧数。*/
+    currFrame: number;
+    /**@internal 两帧之间的时间间隔,单位毫秒。*/
+    private _delta;
+    /**@internal */
+    private _lastTimer;
+    /**@private */
+    private _map;
+    /**@private */
+    private _handlers;
+    /**@private */
+    private _temp;
+    /**@private */
+    private _count;
+    private static created;
+    static getGID(): number;
+    /**
+     * 创建 <code>Timer</code> 类的一个实例。
+     */
+    constructor();
+    /**
+     * 启动
+     */
+    enable(): void;
+    private _impl;
+    private get impl();
+    /**两帧之间的时间间隔,单位毫秒。*/
+    get delta(): number;
+    /**
+     * @internal
+     * 帧循环处理函数。
+     */
+    private _update;
+    /** @private */
+    private _clearHandlers;
+    /** @private */
+    private _recoverHandler;
+    /** @internal */
+    private _create;
+    /** @private */
+    private _indexHandler;
+    /**
+     * 定时执行一次。
+     * @param	delay	延迟时间(单位为毫秒)。
+     * @param	caller	执行域(this)。
+     * @param	method	定时器回调函数。
+     * @param	args	回调参数。
+     * @param	coverBefore	是否覆盖之前的延迟执行，默认为 true 。
+     */
+    once(delay: number, caller: any, method: Function, args?: any[], coverBefore?: boolean): void;
+    /**
+     * 定时重复执行。
+     * @param	delay	间隔时间(单位毫秒)。
+     * @param	caller	执行域(this)。
+     * @param	method	定时器回调函数。
+     * @param	args	回调参数。
+     * @param	coverBefore	是否覆盖之前的延迟执行，默认为 true 。
+     * @param	jumpFrame 时钟是否跳帧。基于时间的循环回调，单位时间间隔内，如能执行多次回调，出于性能考虑，引擎默认只执行一次，设置jumpFrame=true后，则回调会连续执行多次
+     */
+    loop(delay: number, caller: any, method: Function, args?: any[], coverBefore?: boolean, jumpFrame?: boolean): void;
+    /**
+     * 定时执行一次(基于帧率)。
+     * @param	delay	延迟几帧(单位为帧)。
+     * @param	caller	执行域(this)。
+     * @param	method	定时器回调函数。
+     * @param	args	回调参数。
+     * @param	coverBefore	是否覆盖之前的延迟执行，默认为 true 。
+     */
+    frameOnce(delay: number, caller: any, method: Function, args?: any[], coverBefore?: boolean): void;
+    /**
+     * 下一帧执行。
+     * @param	caller 执行域(this)。
+     * @param	method 定时器回调函数。
+     * @param	args 回调参数。
+     */
+    frameNext(caller: any, method: Function, ...args: any[]): void;
+    /**
+     * 定时重复执行(基于帧率)。
+     * @param	delay	间隔几帧(单位为帧)。
+     * @param	caller	执行域(this)。
+     * @param	method	定时器回调函数。
+     * @param	args	回调参数。
+     * @param	coverBefore	是否覆盖之前的延迟执行，默认为 true 。
+     */
+    frameLoop(delay: number, caller: any, method: Function, args?: any[], coverBefore?: boolean): void;
+    /** 返回统计信息。*/
+    toString(): string;
+    /**
+     * 清理定时器。
+     * @param	caller 执行域(this)。
+     * @param	method 定时器回调函数。
+     */
+    clear(caller: any, method: Function): void;
+    /**
+     * 清理对象身上的所有定时器。
+     * @param	caller 执行域(this)。
+     */
+    clearAll(caller: any): void;
+    /** @private */
+    private _getHandler;
+    /**
+     * 立即提前执行定时器，执行之后从队列中删除
+     * @param	caller 执行域(this)。
+     * @param	method 定时器回调函数。
+     */
+    runTimer(caller: any, method: Function): void;
+    /**
+     * 暂停时钟
+     */
+    pause(): void;
+    /**
+     * 恢复时钟
+     */
+    resume(): void;
+}
+/**
+ * 心跳
+ */
+export declare const timer: Timer;

package/dist/app/module/timer/TimerImpl.d.ts

@@ -0,0 +1,10 @@
+import { ITimer } from "./ITimer";
+import { Timer } from "./Timer";
+/**
+ * 通用计时器实现。
+ * 使用 setInterval 驱动 Timer 的内部更新循环。
+ */
+export declare class TimerImpl implements ITimer {
+    private _intervalMap;
+    enable(timer: Timer): void;
+}

package/dist/app/module/utils/md5.d.ts

@@ -0,0 +1,3 @@
+declare function hex_md5(s: any): string;
+export declare const md5: typeof hex_md5;
+export {};

package/dist/app/module/view/IView.d.ts

@@ -0,0 +1,94 @@
+import { AnalyticsData } from "../analytics/index";
+import { ViewConfig } from "./IViewLoader";
+import { ViewAnalyticsInfo } from "./ViewManager";
+/**
+ * Tips类型枚举
+ */
+export declare enum TipsType {
+    /**
+     * 常规提示
+     */
+    normal = 0,
+    /**
+     * 警告
+     */
+    warn = 1,
+    /**
+     * 错误
+     */
+    error = 2
+}
+/**
+ * 视图类，控制本身和子项的显示逻辑
+ */
+export interface IView {
+    name: string;
+    config: ViewConfig;
+    analyticsInfo: ViewAnalyticsInfo;
+    touchEnabled: boolean;
+    /**
+     * 是否在舞台上
+     */
+    readonly inStage: boolean;
+    addView(view: IView, index?: number): void;
+    removeView(view: IView, destroy?: boolean): void;
+    setData(...data: any[]): void;
+    close(...eventParams: any[]): void;
+    removeFromParent(destroy?: boolean): void;
+    allDestroy(): void;
+    /**
+     * 视图内发生事件时，动态获取上报的信息。比如关卡内的动态数据。
+     * @param event
+     */
+    getAnalyticsDataOnViewEvent?(event: "open" | "close" | string): AnalyticsData;
+}
+/**
+ * 场景类
+ */
+export interface IScene extends IView {
+    /**
+     * 显示正常提示
+     * @param tipContent 提示文本内容
+     */
+    tips(message: string): void;
+    /**
+     * 显示警告提示
+     * @param tipContent 警告文本内容
+     */
+    warn(message: string): void;
+    /**
+     * 显示错误提示
+     * @param tipContent 错误文本内容
+     */
+    error(message: string): void;
+    /**
+     * 添加视图到场景最上层
+     * @param view
+     */
+    addToTopup(view: IView): void;
+    /**
+     * 添加视图到网络层
+     * @param view
+     */
+    addToNet(view: IView): void;
+    /**
+     * 添加视图到引导层
+     * @param view
+     */
+    addToTutorial(view: IView): void;
+    /**
+     * 添加视图到弹出层
+     * @param view
+     */
+    addToAlert(view: IView): void;
+    /**
+     * 添加视图到UI层
+     * @param view
+     */
+    addToUI(view: IView): void;
+    /**
+     * 添加视图到背景层
+     * @param view
+     */
+    addToBG(view: IView): void;
+}

package/dist/app/module/view/IViewLoader.d.ts

@@ -0,0 +1,48 @@
+import { EventDispatcher } from "../../base/event/EventDispatcher";
+import { IRecoverable } from "../../base/pool/IRecoverable";
+import { Pool } from "../../base/pool/Pool";
+import { Task } from "../task/Task";
+import { TaskSequence } from "../task/TaskSequence";
+import { IView } from "./IView";
+export type ViewConfig = {
+    /**
+     * 视图路径
+     */
+    path: string;
+    /**
+     * 视图名称
+     */
+    name?: string;
+    /**
+     * 视图默认显示层级
+     */
+    zIndex?: number;
+    /**
+     * 视图加载器类型
+     */
+    loaderType?: string;
+    /**
+     * 是否缓存视图
+     */
+    cache?: boolean;
+};
+/**
+ * 视图加载器
+ */
+export declare abstract class IViewLoader extends EventDispatcher implements IRecoverable {
+    protected _pool: Pool<IViewLoader>;
+    protected _asset: any;
+    protected _initializer: TaskSequence;
+    constructor(pool: Pool<IViewLoader>);
+    abstract init(config: ViewConfig): IViewLoader;
+    load(task?: Task): void;
+    /**
+     * 创建视图
+     * @param viewName 视图名称
+     * @param recoverLoader 还原loader
+     */
+    abstract initView<T extends IView>(viewName: string, recoverLoader?: boolean): T;
+    destroy(): void;
+    reset(): void;
+    recover(): void;
+}