keytops-game-framework 1.0.0

package/dist/native/CocosNativeHelper.d.ts

@@ -0,0 +1,12 @@
+import { INativeHelper } from "../app/module/native/INativeHelper";
+/**
+ @name: NativeHelper
+@desc: cocos 2.4.x 下nativeHelper
+@author: timoo
+@date: 2022/12/02
+*/
+export declare class CocosNativeHelper extends INativeHelper {
+    callWithReturnType(className: string, methodName: string, returnType: string | number | boolean, ...args: any[]): string | number | boolean;
+    private getArgsSig;
+    private getValueTypeStr;
+}

package/dist/resource/ResourceManager.d.ts

@@ -0,0 +1,187 @@
+import { Task } from "../app/module/task/Task";
+import * as cc from "cc";
+export type ResourceInfo = {
+    /**
+     * 资源的完整原始路径
+     */
+    fullPath: string;
+    /**
+     * 资源所属的bundle下面的路径
+     */
+    path: string;
+    /**
+     * bundle资源所属bundle名称
+     */
+    bundle: string;
+    /**
+     * 是否为远程资源
+     */
+    isRemote: boolean;
+    /**
+     * 资源地址是否指向文件夹，通过最后的字符是否为"/"获得
+     */
+    isDir: boolean;
+};
+/**
+ * 资源管理
+ */
+export declare class ResourceManager {
+    private _bundleVersionMap;
+    private _loadPromiseMap;
+    private _loadBunldePromiseMap;
+    private _waitToReleaseBundles;
+    private _startedGC;
+    /**
+     * 预加载资源
+     * @param cc.path - `bundleName://cc.path/to/asset`目标素材的资源地址
+     * @param task - `Task` 可选参数，任务回调
+     * @returns
+     *
+     * @example
+     *
+     * //预加载主包内的素材
+     * preload("main://cc.path/to/asset")
+     * //预加载动态资源中的素材
+     * preload("resource://cc.path/to/asset")
+     * //预加载其他包中的资源
+     * preload("bundleName://cc.path/to/asset")
+     * //预加载远程服务器上的资源
+     * preload("https://cc.path/to/sound.mp3")
+     * preload("https://cc.path/to/image.png")
+     * //预加载文件夹
+     * preload("bundleName://cc.path/to/dir/")
+     */
+    preload(path: string, task?: Task): Promise<string>;
+    preload(path: string[], task?: Task): Promise<string[]>;
+    preload(path: string | string[], task?: Task): Promise<string | string[]>;
+    /**
+     * 预加载场景
+     * @param cc.path - `bundleName://cc.path/to/sceneName` 目标场景的加载地址，
+     * @param task - `Task` 可选参数，任务回调
+     * @returns
+     *
+     * @example
+     * //加载主包中的场景
+     * preLoadScene("main://cc.path/to/sceneName")
+     * //加载动态包中的场景
+     * preLoadScene("resources://cc.path/to/sceneName")
+     * //加载其他bundle中的场景
+     * preLoadScene("bundleName://cc.path/to/sceneName")
+     */
+    preLoadScene(path: string, task?: Task): Promise<string>;
+    preLoadScene(path: string[], task?: Task): Promise<string[]>;
+    preLoadScene(path: string | string[], task?: Task): Promise<string | string[]>;
+    private _preLoadFromRemote;
+    private _preLoadFromBundle;
+    /**
+     * 加载资源
+     * @param cc.path - `bundleName://cc.path/to/asset`目标素材的资源地址
+     * @param assetType - 可选参数，cocos资源类型（Asset子类），当返回类型不是预期类型时，需要手动指定，如SpriteFrame
+     * @param task - `Task` 可选参数，任务回调
+     * @returns 全部失败后返回null
+     *
+     * @example
+     * //预加载主包内的素材
+     * load("main://cc.path/to/asset")
+     * //预加载动态资源中的素材
+     * load("resource://cc.path/to/asset")
+     * //预加载其他包中的资源
+     * load("bundleName://cc.path/to/image")
+     * //预加载远程服务器上的资源
+     * load("https://cc.path/to/asset.mp3")
+     * load("https://cc.path/to/image.png")
+     * //预加载文件夹
+     * load("bundleName://cc.path/to/dir/")
+     */
+    load<T extends cc.Asset>(path: string, assetType?: new () => T, task?: Task): Promise<T>;
+    load<T extends cc.Asset>(path: string[], assetType?: new () => T, task?: Task): Promise<T[]>;
+    load<T extends cc.Asset>(path: string | string[], assetType?: new () => T, task?: Task): Promise<T | T[]>;
+    private _loadFromBundle;
+    private _loadfromRemote;
+    /**
+     * 解析资源路径成PathInfo
+     * @param fullPath - 资源路径应该符合bundle://cc.path/to/resource格式
+     * @returns - `PathInfo` 资源信息
+     */
+    parsePath(fullPath: string): ResourceInfo;
+    /**
+     * 获取目标bundle的资源的完整路径
+     * @param bundleName - 资源所在bundle名称
+     * @param subPath - 可选参数, 相对子路径
+     * @returns
+     */
+    getPath(bundleName: string, subPath?: string): string;
+    /**
+     * 获取主包下资源的完整路径
+     * @param subPath 资源子路径
+     * @returns
+     */
+    getPathInMain(subPath: string): string;
+    /**
+     * 获取动态包下资源的完整路径
+     * @param subPath 资源子路径
+     * @returns
+     */
+    getPathInResources(subPath: string): string;
+    /**
+     * 加载Bundle
+     * @param bundleName Bundle名称
+     * @returns `Promise<cc.AssetManager.Bundle>`
+     */
+    getBundle(bundleName: string): Promise<cc.AssetManager.Bundle>;
+    /**
+     * bundle是否被加载过，且有效
+     * @param bundleName
+     * @returns
+     */
+    isBundleValid(bundleName: string): Promise<boolean>;
+    /**
+     * 移除并销毁bundle，以及bundle下所有资源。
+     * @param bundleName bundle名称
+     * @param delay 是否延后销毁，默认为true
+     * @returns
+     */
+    removeBundle(bundleName: string, delay?: boolean): Promise<boolean>;
+    /**
+     * 推送bundle到GC队列
+     * @param bundle
+     */
+    private _pushBundleToReleaseMap;
+    /**
+     * 删除等待销毁的bundle，如果有
+     * @param bundleName
+     * @returns
+     */
+    private _removeBundleFromReleaseMap;
+    /**
+     * 真正移除bundle
+     * @param bundle 目标bundle
+     * @returns
+     */
+    private _onRemoveBundle;
+    /**
+     * 开始Bundle GC，只执行一次
+     * @returns
+     */
+    private _startGC;
+    /**
+     * GC Bundle
+     * @returns
+     */
+    private _onGC;
+    /**
+     * 手动设置bundle的版本,可新增可以覆盖。
+     * @param map
+     */
+    setBundleVersion(map: Map<string, string>): void;
+    /**
+     * 获取bundle的版本
+     * @param bundleName
+     * @returns
+     */
+    private _getBundleVersion;
+}
+/**
+ * cocos资源加载和管理
+ */
+export declare const res: ResourceManager;

package/dist/utils/Async.d.ts

@@ -0,0 +1,28 @@
+import { CCObject } from "cc";
+export declare class Async {
+    /**
+     * 等待多少次 update 帧
+     * @param count 次数，默认为1
+     * @param component 执行等待的组件，目的用于该组件被销毁时让此等待也随之失效
+     */
+    static waitUpdateFrame(count?: number, component?: CCObject): Promise<void>;
+    /**
+     * 等待多少次渲染帧（渲染帧只有在调用了 cc.game.pause() 方法后才会停止更新，所以即使调用
+     * 了 cc.director.pause() 方法此等待任然会执行）
+     * @param count 次数，默认为1
+     * @param component 执行等待的组件，目的用于该组件被销毁时让此等待也随之失效
+     */
+    static waitRenderFrame(count?: number, component?: CCObject): Promise<void>;
+    /**
+     * 等待多少秒
+     * @param second 秒
+     * @param component 执行等待的组件，目的用于该组件被销毁时让此等待也随之失效
+     */
+    static waitSecond(second: number, component?: CCObject): Promise<void>;
+    /**
+     * 等待条件满足
+     * @param condition 条件
+     * @param context 作用域（如果是CCObject则会跟随销毁而失效）
+     */
+    static waitUntil(condition: () => boolean, context?: Object): Promise<void>;
+}

package/dist/utils/CocosStorageUtils.d.ts

@@ -0,0 +1,10 @@
+import { IStorage } from "../app/module/storage/Storage";
+/**
+ * cocos下的本地持久化实现类
+ */
+export declare class CocosStorageUtils implements IStorage {
+    removeValue(key: string): void;
+    setValue(key: string, value: string | number | boolean): void;
+    getValue<T>(key: string): T;
+    clear(): void;
+}

package/dist/utils/GeometryUtils.d.ts

@@ -0,0 +1,31 @@
+import * as cc from "cc";
+/**
+ * 几何工具（无优化）
+ * @author 陈皮皮 (ifaswind)
+ * @version 20220107
+ * @see GeometryUtil.ts https://gitee.com/ifaswind/eazax-ccc/blob/master/utils/GeometryUtil.ts
+ */
+export declare class GeometryUtils {
+    /**
+     * 判断点是否在线段上
+     * @param p 目标点
+     * @param a 线段端点 a
+     * @param b 线段端点 b
+     */
+    static pointOnLine(p: cc.Vec3, a: cc.Vec3, b: cc.Vec3): boolean;
+    /**
+     * 判断点是否在三角形内（同向法）
+     * @param p 目标点
+     * @param a 三角形顶点 a
+     * @param b 三角形顶点 b
+     * @param c 三角形顶点 c
+     */
+    static pointInTriangle(p: cc.Vec3, a: cc.Vec3, b: cc.Vec3, c: cc.Vec3): boolean;
+    /**
+     * 获取点到线段的最短距离
+     * @param p 目标点
+     * @param a 线段端点 a
+     * @param b 线段端点 b
+     */
+    static pointLineDistance(p: cc.Vec3, a: cc.Vec3, b: cc.Vec3): number;
+}

package/dist/view/CCPViewLoader.d.ts

@@ -0,0 +1,95 @@
+import { Task } from "../app/module/task/Task";
+import { IView } from "../app/module/view/IView";
+import { ViewConfig, IViewLoader } from "../app/module/view/IViewLoader";
+import * as cc from "cc";
+export type CCPViewConfig = {
+    /**
+     * 视图所需的附属资源，默认为空。
+     */
+    res?: string | string[];
+    /**
+     * 视图非必要的预加载资源，默认为空。只负责调起预加载，不保证加载成功。
+     */
+    preRes?: string | string[];
+    /**
+     * 挂载的View Class名称，默认为"View"。
+     */
+    viewClassName?: string;
+    /**
+     * 挂载的View Class。
+     */
+    viewClass?: {
+        prototype: IView;
+    };
+} & ViewConfig;
+/**
+ * 注册View配置的装饰器(CCPViewLoader)
+ * @param data 视图配置 CCPViewConfig=
+ * @{
+ * @ path 视图预制体路径
+ * @ [name] 可选，视图名称, 默认为ViewClassName, 默认和视图预制体同名
+ * @ [zIndex] 可选，视图显示层级, 默认为ViewLevel.UI
+ * @ [viewClassName] 可选，视图根所挂载的ViewClass, 默认和视图预制体同名
+ * @ [cache] 可选，界面是否缓存
+ * @ [res] 可选，视图依赖的资源列表，默认为空
+ * @ [preRes] 可选，视图加载完后发起的预加载资源列表，默认为空
+ * @}
+ *
+ * @example
+ * ```
+ * //通过装饰器注册视图
+ * [@]viewClass({
+        path: "Lv1://Prefab/Lv", cache: false, zIndex: ViewLevel.UI, viewClassName: "Lv1",
+        //加载视图时，同时加载的依赖资源
+        //res:[],
+        //加载视图后，发起的预加载资源
+        //preRes:[]
+    })
+    export class Lv1 extends View {
+    }
+
+    //注册Lv1的class（同一个class）到Lv101视图
+    viewClass({path: "Lv101://Prefab/Lv", cache: false, zIndex: ViewLevel.UI, viewClassName: "Lv1", name: "Lv101"})(Lv1);
+    //注册Lv1的class（同一个class）到Lv102视图
+    viewClass({path: "Lv102://Prefab/Lv", cache: false, zIndex: ViewLevel.UI, viewClassName: "Lv1", name: "Lv102"})(Lv1);
+ * ```
+ */
+export declare function viewClass(data: CCPViewConfig): any;
+/**
+ * cocos 默认视图加载器（Prefab）
+ */
+export declare class CCPViewLoader extends IViewLoader {
+    static TYPE: string;
+    /**
+     * 创建CCPViewLoader的View配置
+     * @param data 视图配置 CCPViewConfig=
+     * @{
+     * @ path 视图预制体路径
+     * @ [name] 可选，视图名称, 默认为ViewClassName, 默认和视图预制体同名
+     * @ [zIndex] 可选，视图显示层级, 默认为ViewLevel.UI
+     * @ [viewClassName] 可选，视图根所挂载的ViewClass, 默认和视图预制体同名
+     * @ [res] 可选，视图依赖的资源列表，默认为空
+     * @ [preRes] 可选，视图加载完后发起的预加载资源列表，默认为空
+     * @ [cache] 可选，界面是否缓存
+     * @}
+     */
+    static createConfig(data: CCPViewConfig): CCPViewConfig;
+    protected _config: CCPViewConfig;
+    protected _viewBundle: cc.AssetManager.Bundle;
+    init(config: CCPViewConfig): CCPViewLoader;
+    /**
+     * 加载视图预制体
+     * @param task
+     * @param config
+     */
+    protected _loadView(task: Task, config: CCPViewConfig): void;
+    /**
+     * 加载视图所需的附属资源
+     * @param task
+     * @param config
+     */
+    protected _loadRes(task: Task, config: CCPViewConfig): void;
+    initView<T extends IView>(viewName: string, recoverLoader?: boolean): T;
+    reset(): void;
+    destroy(): void;
+}

package/dist/view/CCSceneLoader.d.ts

@@ -0,0 +1,25 @@
+import { Task } from "../app/module/task/Task";
+import { IView } from "../app/module/view/IView";
+import { CCPViewLoader, CCPViewConfig } from "./CCPViewLoader";
+/**
+ * cocos 默认视图加载器（Scene）
+ */
+export declare class CCSceneLoader extends CCPViewLoader {
+    static TYPE: string;
+    /**
+     * 创建CCSceneLoader的View配置
+     * @param data 视图配置 CCPViewConfig=
+     * @{
+     * @ path 视图预制体路径
+     * @ [name] 可选，视图名称, 默认为ViewClassName, 默认和视图预制体同名
+     * @ [zIndex] 可选，视图显示层级, 默认为ViewLevel.UI
+     * @ [viewClassName] 可选，视图根所挂载的ViewClass, 默认和视图预制体同名
+     * @ [res] 可选，视图依赖的资源列表，默认为空
+     * @ [preRes] 可选，视图加载完后发起的预加载资源列表，默认为空
+     * @ [cache] 可选，界面是否缓存
+     * @}
+     */
+    static createConfig(data: CCPViewConfig): CCPViewConfig;
+    protected _loadView(task: Task, config: CCPViewConfig): void;
+    initView<T extends IView>(viewName: string, recoverLoader?: boolean): T;
+}

package/dist/view/CocosViewManager.d.ts

@@ -0,0 +1,12 @@
+import { IViewLoader, ViewConfig } from "../app/module/view/IViewLoader";
+import { IViewManager } from "../app/module/view/ViewManager";
+export declare class CocosViewManager implements IViewManager {
+    private _loaderPoolMap;
+    /**
+     * 从loader池中获取loader
+     * @param loaderType
+     * @returns
+     */
+    getLoader(config: ViewConfig): IViewLoader;
+    private _getLoaderPool;
+}

package/dist/view/Scene.d.ts

@@ -0,0 +1,35 @@
+import { IScene, TipsType } from "../app/module/view/IView";
+import { View } from "./View";
+import { ViewControl } from "./ViewControl";
+export declare class Scene extends View implements IScene {
+    sceneName: string;
+    private _tipsViewLoader;
+    setControl(control: ViewControl): void;
+    addView(view: View, index?: number): void;
+    /**
+     * 显示正常提示
+     * @param message 提示文本内容
+     * @param stay 停留时长，秒
+     */
+    tips(message: string, stay?: number): void;
+    /**
+     * 显示警告提示
+     * @param message 警告文本内容
+     * @param stay 停留时长，秒
+     */
+    warn(message: string, stay?: number): void;
+    /**
+     * 显示错误提示
+     * @param message 错误文本内容
+     * @param stay 停留时长，秒
+     */
+    error(message: string, stay?: number): void;
+    protected _tips(tipContent: string, type: TipsType, stay?: number): Promise<void>;
+    protected onDestroy(): void;
+    addToTopup(view: View): void;
+    addToNet(view: View): void;
+    addToTutorial(view: View): void;
+    addToAlert(view: View): void;
+    addToUI(view: View): void;
+    addToBG(view: View): void;
+}

package/dist/view/View.d.ts

@@ -0,0 +1,151 @@
+import { AnalyticsData } from "../app/module/analytics/index";
+import { IView } from "../app/module/view/IView";
+import { ViewAnalyticsInfo } from "../app/module/view/ViewManager";
+import * as cc from "cc";
+import { CCPViewConfig } from "./CCPViewLoader";
+import { ViewControl } from "./ViewControl";
+export declare enum ViewLevel {
+    TOPUP = 500,
+    NET = 400,
+    TUTORIAL = 300,
+    ALERT = 200,
+    UI = 100,
+    BG = 1
+}
+export declare class View extends cc.Component implements IView {
+    /**
+     * View类的Class名称
+     */
+    static type: string;
+    /**
+     * 视图名称，加载View时自动赋值。
+     */
+    /**
+     * 视图配置，加载View时自动赋值。
+     */
+    config: CCPViewConfig;
+    /**
+     * 视图统计信息
+     */
+    analyticsInfo: ViewAnalyticsInfo;
+    /**
+     * 视图所在bundle，加载View时自动赋值。
+     */
+    bundle: cc.AssetManager.Bundle;
+    /**
+     * 视图的控制器，在Scene中创建。
+     */
+    protected _control: ViewControl;
+    /**
+     * 视图顶层的遮罩，辅助touchEnabled完成当前视图的可交互性。
+     */
+    private _mask;
+    /**
+     * 是否可以交互
+     */
+    private _touchEnabled;
+    /**
+     * 是否在舞台中显示着
+     */
+    get inStage(): boolean;
+    /**
+     * 视图是否响应交互
+     */
+    get touchEnabled(): boolean;
+    /**
+     * 视图是否响应交互
+     */
+    set touchEnabled(value: boolean);
+    /**
+     * 添加其他视图
+     * @param view 其他视图
+     * @param index 视图索引
+     */
+    addView(view: View, index?: number): void;
+    /**
+     * 移除子视图
+     * @param view 子视图
+     * @param destroy 是否销毁，默认为true
+     * @param closeEventParams 视图close事件的参数
+     */
+    removeView(view: View, destroy?: boolean, ...closeEventParams: any[]): void;
+    /**
+     * 设置主场景所创建的Control
+     * @param control
+     */
+    setControl(control: ViewControl): void;
+    protected control<T extends ViewControl>(): T;
+    /**
+     * 实例化后显示到舞台之后调用,缓存视图重新显示时也会调用。
+     * @param data
+     */
+    setData(...data: any[]): void;
+    /**
+     * 上报当前视图统计数据
+     * @param event open和close以外的统计名称，名称必须为全小写，无下划线之外的其他特殊字符。
+     * @param data 上报附带信息，可选参数，为空时会尝试从getAnalyticsDataOnViewEvent获取附带信息。
+     */
+    protected _report(event: string, data?: AnalyticsData): void;
+    /**
+     * 播放BG音乐
+     * @param path 路径 - `bundleName://path/to/asset` 目标音频地址。
+     * @param fade 是否渐进式播放，默认为true
+     * @param loop 是否循环 默认为true
+     * @param onFinishCallBack 单次播放结束后的回调箭头函数（cocos的锅)
+     * @returns 背景音乐的audioId
+     *
+     * @example
+     * _playBG("https://server.com/game/music.mp3")
+     * _playBG("main://path/to/music")
+     * _playBG("resources://path/to/music")
+     */
+    playBG(path: string, fade?: boolean, loop?: boolean, onFinishCallBack?: () => void, volume?: number): Promise<void>;
+    /**
+     * 播放音效
+     * @param path 路径 - `bundleName://path/to/asset` 目标音频地址。
+     * @param onFinishCallBack 单次播放结束后的回调箭头函数（cocos的锅)
+     * @returns 音效的audioId
+     */
+    playEffect(path: string, onFinishCallBack?: () => void, volume?: number): Promise<void>;
+    /**
+     * 播放激励视频的快捷方式。
+     * @param from 可选参数，可以附带广告行为的来源，以及其他需要统计的信息
+     * @param stopRecorder 可选参数，是否暂停录屏， 默认为true
+     */
+    showRewardVideo(from?: {
+        action?: string;
+        [key: string]: string | boolean | number;
+    }, stopRecorder?: boolean): Promise<boolean>;
+    /**
+     * 分享录屏视频
+     * @param analyticsName 玩法发起分享的动作来源，用于统计。
+     * @param title 视频标题
+     * @param topics 视频话题列表
+     */
+    shareRecord(analyticsName: string, title: string, topics: string[]): Promise<boolean>;
+    /**
+     * 子项重写时，必须要调用super.onDestroy()。
+     *
+     */
+    protected onDestroy(): void;
+    /**
+     * 父级视图
+     */
+    get parentView(): View;
+    /**
+     * 关闭视图,根据视图是否缓存选择是否销毁视图
+     * @param closeEventParams 视图close事件的参数
+     */
+    close(...closeEventParams: any[]): void;
+    /**
+     * 从父级移除视图
+     * @param destroy 是否销毁，默认为true
+     * @param closeEventParams 视图close事件的参数
+     */
+    removeFromParent(destroy?: boolean, ...closeEventParams: any[]): void;
+    /**
+     * 直接销毁
+     */
+    allDestroy(): void;
+    getAnalyticsDataOnViewEvent(event: "open" | "close" | string): AnalyticsData;
+}