keytops-game-framework 1.0.0

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

@@ -0,0 +1,242 @@
+import { AnalyticsData } from "../analytics/index";
+import { Task } from "../task/Task";
+import { IView, IScene } from "./IView";
+import { ViewConfig, IViewLoader } from "./IViewLoader";
+/**
+ * 注册进入视图时，上报的事件名称，不注册则上报视图配置的name属性
+* @param analyticsName 可选参数，默认为view的name，可以指定为上报的中文名称
+ * @param group 分组，默认为default，方便分类统计
+ * @returns
+ */
+export declare function viewAnalytics(analyticsName?: string, group?: string): any;
+export interface IViewManager {
+    getLoader(config: ViewConfig): IViewLoader;
+}
+export type ViewAnalyticsInfo = {
+    name: string;
+    group?: string;
+};
+/**
+ * 视图管理类
+ */
+export declare class ViewManager {
+    static KEY: string;
+    private _viewConfigMap;
+    private _viewAnalyticsMap;
+    private _scene;
+    private _currentView;
+    private _currentStack;
+    private _viewCache;
+    private _currentMaskView;
+    private _viewEvent;
+    private static created;
+    /**
+     * 注册视图上报事件的视图名称，一般为中文方便数据分辨
+     * @param viewClass
+     * @param analyticsName 可选参数，默认为view的name，可以指定为上报的中文名称
+     * @param group 分组，可选参数，默认为default，方便分类统计
+     */
+    registerAnalytics(viewClass: {
+        prototype: IView;
+    } | string, analyticsName?: string, group?: string): void;
+    /**
+     * 注册视图类对应的视图配置
+     * @param viewName 视图名称
+     * @param config 视图配置
+     */
+    registerView(viewName: string, config: ViewConfig): void;
+    /**
+     * 获取视图配置
+     * @param config
+     * @returns
+     */
+    getViewConfig<T extends ViewConfig>(config: T): T;
+    /**
+     * 获取视图配置
+     * @param veiwName 视图名称
+     */
+    getViewConfig<T extends ViewConfig>(veiwName: string): T;
+    /**
+     * 获取视图配置
+     * @param viewClass 视图class
+     */
+    getViewConfig<T extends ViewConfig>(viewClass: {
+        prototype: IView;
+    }): T;
+    getViewConfig<T extends ViewConfig>(config: {
+        prototype: IView;
+    } | T | string): T;
+    /**
+     * [内部直接获取]获取视图配置
+     * @param config
+     * @returns
+     */
+    private _getViewConfig;
+    constructor();
+    /**
+     * 场景启动后设置场景，不建议手动调用
+     * @param root
+     */
+    setRoot(root: IScene): void;
+    /**
+     * 切换场景
+     * @param config 目标场景的配置|Class|名称
+     * @param data
+     * @returns
+     */
+    switchScene<T extends IScene>(config: {
+        prototype: IScene;
+    } | ViewConfig | string, ...data: any[]): Promise<T>;
+    /**
+     * 当前场景
+     * @returns
+     */
+    scene<T extends IScene>(): T;
+    /**
+     * 开启当前场景的可交互性
+     */
+    openTouch(): void;
+    /**
+     * 关闭当前场景的可交互性
+     * @param maskViewConfig 可选参数，默认为空白，要显示的遮罩试图。
+     * @param delay 可选参数，默认200毫秒，显示maskView的延迟时间。
+     */
+    closeTouch(maskViewConfig?: {
+        prototype: IView;
+    } | ViewConfig | string, delay?: number): Promise<void>;
+    /**
+     * 当前主视图
+     * @returns
+     */
+    view<T extends IView>(): T;
+    /**
+     * 切换主视图到目标视图
+     * @param target 目标视图的配置|Class|名称
+     * @param datas 目标视图初始化参数
+     */
+    switchTo<T extends IView>(config: {
+        prototype: IView;
+    } | ViewConfig | string, ...data: any[]): Promise<T>;
+    /**
+     * 切回当前主视图到上一个主视图。
+     * @param data
+     * @returns
+     */
+    switchBack<T extends IView>(...data: any[]): Promise<T>;
+    private _switchView;
+    private _switchViewByConfig;
+    /**
+     * 通过视图配置添加视图
+     * @param viewConfig 要添加的视图配置|Class|名称
+     * @param parent 父级视图，默认为当前主视图，即viewMananger.current()
+     * @param datas 传入setData的数据
+     */
+    addView<T extends IView>(config: {
+        prototype: IView;
+    } | ViewConfig | string, parent?: IView, ...datas: any[]): Promise<T>;
+    private _addView;
+    private _addViewbyConfig;
+    /**
+     * 加载视图到内存，之后还需要调用loader.initView接口获取view
+     * @param config 要加载的视图配置|Class|名称
+     * @param task 任务载体
+     */
+    loadView(config: {
+        prototype: IView;
+    } | ViewConfig | string, task?: Task): Promise<IViewLoader>;
+    /**
+     * 获取缓存视图
+     * @param config
+     * @returns
+     */
+    getCacheView<T extends IView>(config: {
+        prototype: IView;
+    } | ViewConfig | string): T | null;
+    /**
+     * 缓存视图
+     * @param view
+     * @param force 默认为false，不考虑view.config.cache的值，强制增加到缓存
+     * @returns
+     */
+    cacheView(view: IView, force?: boolean): boolean;
+    /**
+     * 从缓存列表中移除视图。
+     * @param view
+     * @returns
+     */
+    cancelCache(view: IView): boolean;
+    private _viewOpenEventMap;
+    private _viewCloseEventMap;
+    /**
+     * [快捷方式]增加视图打开的事件监听
+     * @param targetView 目标视图Class|名称
+     * @param listener 响应回调
+     * @param caller 回调this
+     * @param once 是否只监听对应视图打开一次。
+     * @param args 其他参数
+     */
+    onViewOpen(targetView: {
+        prototype: IView;
+    } | string, caller: any, listener: (...args: any[]) => void, once?: boolean, ...args: any[]): void;
+    protected _onViewOpen(viewName: string, ...args: any[]): void;
+    /**
+     * [快捷方式]移除视图打开的事件监听
+     * @param listener
+     * @returns
+     */
+    offViewOpen(listener: (...args: any[]) => void): boolean;
+    /**
+     * [快捷方式]增加视图关闭的事件监听
+     * @param targetView 目标视图Class|名称
+     * @param listener 响应回调
+     * @param caller 回调this
+     * @param once 是否只监听对应视图关闭一次。
+     * @param args 其他参数
+     */
+    onViewClose(targetView: {
+        prototype: IView;
+    } | string, caller: any, listener: (...args: any[]) => void, once?: boolean, ...args: any[]): void;
+    /**
+     * [快捷方式]移除视图关闭的事件监听
+     * @param listener
+     * @returns
+     */
+    offViewClose(listener: (...args: any[]) => void): boolean;
+    protected _onViewClose(viewName: string, ...args: any[]): void;
+    /**
+     * 增加视图事件监听
+     * @param event 视图事件名称
+     * @param caller 回调this
+     * @param listener 响应回调
+     * @param once 是否只监听对应视图关闭一次。
+     * @param args 其他参数
+     */
+    onViewEvent(event: string, caller: any, listener: (viewName: string, ...args: any[]) => void, once?: boolean, ...args: any[]): void;
+    /**
+     * 移除视图事件监听
+     * @param event 事件类型
+     * @param caller 事件侦听函数的执行域。
+     * @param listener 事件侦听函数。
+     * @returns
+     */
+    offViewEvent(event: string, caller: any, listener: (viewName: string, ...args: any[]) => void): void;
+    /**
+     * 广播视图事件
+     * @param event 视图事件
+     * @param view 视图
+     */
+    event(event: "open" | "close" | string, view: IView, ...args: any[]): void;
+    /**
+     * 上报视图统计数据(open\close\...)
+     * @param event 事件
+     * @param view 视图
+     * @param data 上报附带信息
+     */
+    reportViewAnalytics(event: "open" | "close" | string, view: IView, data?: AnalyticsData): void;
+    private _impl;
+    private get impl();
+}
+/**
+ * 视图管理器
+ */
+export declare const viewManager: ViewManager;

package/dist/audio/AudioManager.d.ts

@@ -0,0 +1,146 @@
+import { IRecoverable } from "../app/base/pool/IRecoverable";
+import * as cc from "cc";
+export declare class EffectAudioSourceProxy implements IRecoverable {
+    private _audioNode;
+    private _audioSource;
+    private _onFinishCallBack;
+    constructor();
+    /**
+     * 声音大小
+     */
+    set volume(value: number);
+    /**
+     * 声音大小
+     */
+    get volume(): number;
+    /**
+     * 渐进式播放
+     * @param clip
+     * @param volume
+     * @param loop
+     * @param onFinishCallBack
+     * @returns
+     */
+    playfade(clip: cc.AudioClip, volume: number, loop?: boolean, onFinishCallBack?: () => void): Promise<EffectAudioSourceProxy>;
+    /**
+     * 播放
+     * @param clip
+     * @param volume
+     * @param loop
+     * @param onFinishCallBack
+     * @returns
+     */
+    play(clip: cc.AudioClip, volume: number, loop?: boolean, onFinishCallBack?: () => void): EffectAudioSourceProxy;
+    /**
+     * 渐进
+     * @returns
+     */
+    fadeIn(): Promise<EffectAudioSourceProxy>;
+    /**
+     * 渐出
+     * @param stop
+     * @returns
+     */
+    fedeOut(stop?: boolean): Promise<EffectAudioSourceProxy>;
+    /**
+     * 暂停
+     * @returns
+     */
+    pause(): void;
+    /**
+     * 恢复
+     * @returns
+     */
+    resume(): void;
+    /**
+     * 渐进停止
+     * @returns
+     */
+    stopFade(): Promise<void>;
+    /**
+     * 停止
+     * @returns
+     */
+    stop(): void;
+    private _onAudioEnded;
+    /**
+     * 是否循环
+     */
+    get loop(): boolean;
+    /**
+     * 是否播放中
+     */
+    get playing(): boolean;
+    reset(): void;
+    destroy(): void;
+}
+declare class AudioManager {
+    private _musicVolume;
+    private _effectVolume;
+    private _effectPool;
+    private _music;
+    constructor();
+    /**
+     * 音效音量大小
+     */
+    get effectVolume(): number;
+    /**
+     * 音效音量大小
+     */
+    set effectVolume(value: number);
+    /**
+     * BGM音量大小
+     */
+    get musicVolume(): number;
+    /**
+     * BGM音量大小
+     */
+    set musicVolume(value: number);
+    /**
+     * 播放音效
+     * @param clip
+     * @param loop 是否循环，默认为false。传入true，需要手动调用recoverEffect进行回收
+     * @param onFinishCallBack 播放完回调
+     * @param volume  当此播放的声音大小，默认为统一effect的大小
+     */
+    playEffect(clip: cc.AudioClip, loop?: boolean, onFinishCallBack?: () => void, volume?: number): EffectAudioSourceProxy;
+    /**
+     * 回收音效播放器，用于effect多次复用后的回收
+     * @param proxy
+     */
+    recoverEffect(proxy: EffectAudioSourceProxy): void;
+    /**
+     * 停止所有音效
+     */
+    stopAllEffect(): void;
+    /**
+     * 播放背景音乐
+     * @param clip
+     * @param fade 是否渐进式播放，默认为true
+     * @param loop 是否循环，默认为true
+     * @param onFinishCallBack 播放完回调
+     * @param volume 当此播放的声音大小，默认为统一music的大小
+     */
+    playMusic(clip: cc.AudioClip, fade?: boolean, loop?: boolean, onFinishCallBack?: () => void, volume?: number): void;
+    /**
+     * 暂停播放背景音乐
+     * @returns
+     */
+    pauseMusic(): void;
+    /**
+     * 恢复播放背景音乐
+     * @returns
+     */
+    resumeMusic(): void;
+    /**
+     * 停止背景音乐
+     * @param fade 是否渐出
+     * @returns
+     */
+    stopMusic(fade?: boolean): Promise<void>;
+}
+/**
+ * 音效管理
+ */
+export declare const audio: AudioManager;
+export {};

package/dist/business/AudioBusiness.d.ts

@@ -0,0 +1,11 @@
+import { IBusiness } from "../app/module/business/IBusiness";
+export declare class AudioBusiness implements IBusiness {
+    start(): IBusiness;
+    private _registerEvent;
+    private _unregisterEvent;
+    private _onHide;
+    private _onShow;
+    stop(): void;
+    pause(): void;
+    release(): void;
+}

package/dist/cocos.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+export * from './cocos';
+export * from './app/module/abTesting/ABTesting';
+export * from './app/module/net/NetManager';
+export * from './app/module/net/NetInterface';
+export * from './app/module/net/server/SystemOnlineConfig';
+export * from './app/module/net/server/LevelOnlineConfig';
+export * from './app/module/net/server/IServer';
+export * from './app/module/net/server/Server';
+export * from './app/module/net/http/HttpRequest';
+export * from './app/module/net/http/HttpNode';
+export * from './app/module/net/byte/ByteView';
+export * from './app/module/net/socket/Socket';
+export * from './app/module/net/socket/BaseProtocolHelper';
+export * from './app/module/net/socket/SocketNode';
+export * from './app/module/logger/Logger';
+export * from './app/module/native/NativeHelper';
+export * from './app/module/native/INativeHelper';
+export * from './app/module/config/ConfigHelper';
+export * from './app/module/publisher/IPayAble';
+export * from './app/module/publisher/PublisherManager';
+export * from './app/module/publisher/PublisherManagerImpl';
+export * from './app/module/publisher/IShareAble';
+export * from './app/module/publisher/IPublisherManager';
+export * from './app/module/publisher/IADAble';
+export * from './app/module/publisher/IDevice';
+export * from './app/module/publisher/ILoginAble';
+export * from './app/module/publisher/IGameUpdateAble';
+export * from './app/module/publisher/IAble';
+export * from './app/module/publisher/IPublisher';
+export * from './app/module/publisher/IRecordAble';
+export * from './app/module/publisher/native/NativeRecord';
+export * from './app/module/publisher/native/NativeAnalyticsSender';
+export * from './app/module/publisher/native/NativePay';
+export * from './app/module/publisher/native/NativePublisher';
+export * from './app/module/publisher/native/NativeLogin';
+export * from './app/module/publisher/native/NativeAd';
+export * from './app/module/publisher/native/NativeShare';
+export * from './app/module/publisher/native/NativeDevice';
+export * from './app/module/publisher/tk/TKLogin';
+export * from './app/module/publisher/tk/TKPublisher';
+export * from './app/module/publisher/tk/TKDevice';
+export * from './app/module/publisher/tk/TKAd';
+export * from './app/module/publisher/tk/TKAnalyticsSender';
+export * from './app/module/publisher/wx/WXPay';
+export * from './app/module/publisher/wx/WXAnalyticsSender';
+export * from './app/module/publisher/wx/WXLogin';
+export * from './app/module/publisher/wx/WXShare';
+export * from './app/module/publisher/wx/WXDevice';
+export * from './app/module/publisher/wx/WXPublisher';
+export * from './app/module/publisher/wx/WXUpdateGameAble';
+export * from './app/module/publisher/wx/WXAd';
+export * from './app/module/publisher/my/MYPublisher';
+export * from './app/module/publisher/my/MYAd';
+export * from './app/module/publisher/my/MYDevice';
+export * from './app/module/publisher/my/MYLogin';
+export * from './app/module/publisher/ks/KSRecorder';
+export * from './app/module/publisher/ks/KSPublisher';
+export * from './app/module/publisher/ks/KSShare';
+export * from './app/module/publisher/ks/KSLogin';
+export * from './app/module/publisher/ks/KSAd';
+export * from './app/module/publisher/ks/KSDevice';
+export * from './app/module/publisher/tt/TTUpdateGameAble';
+export * from './app/module/publisher/tt/TTShare';
+export * from './app/module/publisher/tt/TTRecorder';
+export * from './app/module/publisher/tt/TTPay';
+export * from './app/module/publisher/tt/TTLogin';
+export * from './app/module/publisher/tt/TTPublisher';
+export * from './app/module/publisher/tt/TTAd';
+export * from './app/module/publisher/tt/TTAnalyticsSender';
+export * from './app/module/publisher/tt/TTDevice';
+export * from './app/module/timer/TimerImpl';
+export * from './app/module/timer/ITimer';
+export * from './app/module/timer/Timer';
+export * from './app/module/business/BusinessCenter';
+export * from './app/module/business/RewardVideoMaskBusiness';
+export * from './app/module/business/IBusiness';
+export * from './app/module/utils/md5';
+export * from './app/module/ecs/ECS';
+export * from './app/module/ecs/Component';
+export * from './app/module/ecs/Entity';
+export * from './app/module/ecs/ECSManager';
+export * from './app/module/ecs/System';
+export * from './app/module/ecs/Mask';
+export * from './app/module/fsm/IFsmState';
+export * from './app/module/fsm/Fsm';
+export * from './app/module/fsm/FsmBase';
+export * from './app/module/fsm/IFsm';
+export * from './app/module/fsm/FsmManager';
+export * from './app/module/storage/Storage';
+export * from './app/module/storage/StorageImpl';
+export * from './app/module/bidding/Bidding';
+export * from './app/module/task/TaskQueue';
+export * from './app/module/task/TaskSequence';
+export * from './app/module/task/Task';
+export * from './app/module/view/ViewManager';
+export * from './app/module/view/IView';
+export * from './app/module/view/IViewLoader';
+export * from './app/module/structure/Dictionary';
+export * from './app/module/structure/List';
+export * from './app/module/structure/Link';
+export * from './app/module/analytics/BaseDimension';
+export * from './app/module/analytics/AnalyticsAbleConst';
+export * from './app/module/analytics/KeytopsAnalyticsSender';
+export * from './app/module/analytics/ALiAnalyticsSender';
+export * from './app/module/analytics/AnalyticsAble';
+export * from './app/module/analytics/index';
+export * from './app/module/analytics/ad/ADBehaviorReporter';
+export * from './app/module/analytics/ad/AdDimension';
+export * from './app/module/analytics/ad/ADAnalyticsAble';
+export * from './app/module/analytics/launch/LaunchAnalyticsAble';
+export * from './app/module/analytics/social/SocialAnalyticsAble';
+export * from './app/module/analytics/social/SocialDimension';
+export * from './app/module/analytics/level/GameDimension';
+export * from './app/module/analytics/level/LevelStatsDimension';
+export * from './app/module/analytics/level/LevelAnalyticsAble';
+export * from './app/module/analytics/level/LevelBehaviorReporter';
+export * from './app/module/analytics/level/PlayerAbilityDimension';
+export * from './app/module/analytics/session/SessionDimension';
+export * from './app/module/analytics/session/SessionAnalyticsAble';
+export * from './app/base/base';
+export * from './app/base/RuntimeApplicationImpl';
+export * from './app/base/utils/MathUtils';
+export * from './app/base/utils/Json';
+export * from './app/base/utils/PromiseUtils';
+export * from './app/base/utils/Injector';
+export * from './app/base/utils/StringUtils';
+export * from './app/base/utils/Handler';
+export * from './app/base/utils/NativeUtils';
+export * from './app/base/pool/Pool';
+export * from './app/base/pool/IRecoverable';
+export * from './app/base/event/Event';
+export * from './app/base/event/EventDispatcher';
+export * from './native/CocosNativeHelper';
+export * from './business/AudioBusiness';
+export * from './utils/Async';
+export * from './utils/CocosStorageUtils';
+export * from './utils/GeometryUtils';
+export * from './audio/AudioManager';
+export * from './view/CCSceneLoader';
+export * from './view/CCPViewLoader';
+export * from './view/View';
+export * from './view/Scene';
+export * from './view/CocosViewManager';
+export * from './view/ViewControl';
+export * from './view/tips/TipsView';
+export * from './resource/ResourceManager';