1 Star 0 Fork 230

xiaoSM/QuickFramework

forked from 周不移/QuickFramework 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
framework.d.ts 36.64 KB
一键复制 编辑 原始数据 按行查看 历史
zhengfasheng 提交于 2021-07-29 22:22 . 11
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097
declare module cc {
export function dump(...args);
//相当于console.info //引擎已经设置为只读,没办法在取一个一样的名字
export function message(...args);
/**@description 相当于console.time */
export function time(...args);
/**@description 相当于console.timeEnd */
export function timeEnd(...args);
export interface Node {
/**@description 用户自定义数据 */
userData: any;
}
/**@description 通过预置体路径创建节点
* @param config 配置信息
* @param config.url 预置体路径
* @param config.view 预置视图资源管理器,继承自UIView
* @param config.completeCallback 创建完成回调
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* cc.createPrefab({url :GAME_RES("res/animations/shzDealerCommon"),view:this,completeCallback:(node)=>{
* if ( node ){
* // to do
* }
* }});
*/
export function createPrefab(config: { url: string, view: any, completeCallback: (node: cc.Node) => void, bundle?: BUNDLE_TYPE });
/**
* @description 扩展一个在界面中加载指定目录的接口
* @param config 配置信息
* @param config.url 资源路径
* @param config.view 资源持有者,继承自UIView
* @param config.onComplete 加载完成回调 data为ResourceCacheData,用之前先判断当前返回的data.data是否是数组
* @param config.onProgress 加载进度
* @param config.bundle 可不填,默认为view指向的bundle
* @param config.type 加载的资源类型
* */
export function loadDir(config: {
bundle?: BUNDLE_TYPE,
url: string,
type: typeof cc.Asset,
view: any,
onProgress?: (finish: number, total: number, item: cc.AssetManager.RequestItem) => void,
onComplete: (data: any) => void
});
/**
* @description 扩展一个在界面加载指定资源接口
* @param config 配置信息
* @param config.bundle 可不填,默认为view指向的bundle
* @param config.url 资源路径
* @param config.type 加载的资源类型
* @param config.onProgress 加载进度
* @param config.onComplete 加载完成回调 data为ResourceCacheData
* @param config.view 资源持有者,继承自UIView
*/
export function load(config: {
bundle?: BUNDLE_TYPE,
url: string,
type: typeof cc.Asset,
onProgress?: (finish: number, total: number, item: cc.AssetManager.RequestItem) => void,
onComplete: (data: any) => void,
view: any,
});
export interface Sprite {
/**
* @description 从网络加载图片,推荐使用第二种方式
* @param url 网络地址,如 : http://tools.itharbors.com/res/logo.png
* @param completeCallback 加载完成回调
* @param defaultSpriteFrame 加载图片失败后,使用的默认图片,当传入string时,会动态加载该默认图片
* @param defaultBundle 若指定了defaultSpriteFrame,不指定defaultBundle ,优先使用view.bundle,否则则为resources目录
* @param isNeedCache 是否需要缓存到本地,如果不需要,每次都会从网络拉取资源,默认都会缓存到本地
* @param config.retain 远程加载的资源是否驻留在内存中,默认都不驻留内存
* @example
* 示例1:
* let sprite = imageNode.getComponent(cc.Sprite);
* sprite.loadRemoteImage({url :"http://tools.itharbors.com/res/logo.png", defaultSpriteFrame : HALL("avatar_default_0.png"), view : this,completeCallback : (data)=>{
* if ( data ) { do something }
* }});
*
* 示例2:
* let sprite = imageNode.getComponent(cc.Sprite);
* sprite.loadRemoteImage({url :"http://tools.itharbors.com/res/logo.png", defaultSpriteFrame : HALL("avatar_default_0.png"), view : this});
*
* 示例3:
* let sprite = imageNode.getComponent(cc.Sprite);
* sprite.loadRemoteImage({url :"http://tools.itharbors.com/res/logo.png", view : this});
* }
*/
loadRemoteImage(config: {
url: string,
view: any,
completeCallback?: (data: cc.SpriteFrame) => void,
defaultSpriteFrame?: string,
defaultBundle?: BUNDLE_TYPE,
isNeedCache?: boolean,
retain?: boolean
});
/**
* @description 加载本地图片
* @param url 图片路径 {urls:string[],key:string} urls 为纹理名如果有此纹理会打包成多张,此时需要传入所有纹理的地址,key指纹理中名字
* @param view 所属视图,UIView的子类
* @param completeCallback 完成回调
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* 示例1:
* sprite.getComponent(cc.Sprite).loadImage({url:{urls:["plist/fish_30","plist/fish_30_1","plist/fish_30_2"],key:"fishMove_030_28"},view:this});
* 示例2:
* sprite.getComponent(cc.Sprite).loadImage({url:"hall/a",view:this});
*/
loadImage(config: {
url: string | { urls: string[], key: string },
view: any,
completeCallback?: (data: SpriteFrame) => void,
bundle?: BUNDLE_TYPE
});
}
export interface Button {
/**
* @description 加载按钮
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* 示例1:
* let button = cc.find("button",this.node);
* button.getComponent(cc.Button).loadButton({normalSprite : "hall/a",view:this});
* button.getComponent(cc.Button).loadButton({normalSprite : "hall/b",pressedSprite : "hall/c",view:this});
* 示例2:
* button.getComponent(cc.Button).loadButton({view:this,
* normalSprite:{urls:["gameComm/chipsetting/chipInfo"],key:"chip0_1"},
* pressedSprite:{urls:["gameComm/chipsetting/chipInfo"],key:"chip0_2"},
* hoverSprite : {urls:["gameComm/chipsetting/chipInfo"],key:"chip1_1"},
* disabledSprite : {urls:["gameComm/chipsetting/chipInfo"],key:"chip1_2"},
* });
* completeCallback.type => ButtonSpriteFrameType
*/
loadButton(config: {
normalSprite?: string | { urls: string[], key: string },
view: any,//UIView的子类
pressedSprite?: string | { urls: string[], key: string },
hoverSprite?: string | { urls: string[], key: string },
disabledSprite?: string | { urls: string[], key: string },
completeCallback?: (type: string, spriteFrame: SpriteFrame) => void,
bundle?: BUNDLE_TYPE
});
}
export interface Label {
/**
* @description 加载字体
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* let content = cc.find("content",this.node);
* content.getComponent(cc.Label).loadFont({font:"font/DFYUANW7-GB2312",view:this});
*/
loadFont(config: { font: string, view: any, completeCallback?: (font: Font) => void, bundle?: BUNDLE_TYPE });
/**@description 强制label在当前帧进行绘制 */
forceDoLayout();
/**
* @description 设置语言包路径,假设语言包为
* @example 示例
* export let i18n = {
* language : cc.sys.LANGUAGE_CHINESE,
* tips : "您好",
* test : "测试 : {0}-->{1}-->{2}"
* }
* node.getComponent(cc.Label).language = "i18n.tips"; //string显示为:您好
* node.getComponent(cc.Label).language = ["i18n.tips"];//string显示为:您好
* node.getComponent(cc.Label).language = ["i18n.test",100,200,300];//string显示为:100-->200-->300
* node.getConponent(cc.Label).language = null;//清除语言路径信息,如果在不需要使用语言包路径时,使用赋值空清除
* */
language: (string | number)[] | string;
}
/**
* @description 强制节点在当前帧进行一次布局
* @example
* cc.updateAlignment(this.node);
* */
export function updateAlignment(node: cc.Node): void;
export interface ParticleSystem {
/**
* @description 加载特效文件 view 为null时,加载之前不会释
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* let node = new cc.Node();
* let par = node.addComponent(cc.ParticleSystem);
* par.loadFile({url:GAME_RES( "res/action/DDZ_win_lizi" ),view:null});
* this.node.addChild(node);
*/
loadFile(config: { url: string, view: any, completeCallback?: (file: ParticleAsset) => void, bundle?: BUNDLE_TYPE });
}
}
declare namespace sp {
export interface Skeleton {
/**
* @description 扩展方法
* @param remotePath 远程资源路径
* @param name 远程Spine文件名,不再后缀
* @param completeCallback 完成回调
* @param isNeedCache 是否需要缓存到本地,如果不需要,每次都会从网络拉取资源,默认都会缓存到本地
* @param config.retain 远程加载的资源是否驻留在内存中,默认都不驻留内存
* @example
* var skeleton = node.addComponent(sp.Skeleton);
*
* let path = "https://bc-test1.oss-cn-shenzhen.aliyuncs.com/image/action";
* let name = "nnoh_v4";
* skeleton.loadRemoteSkeleton({view : this , path : path, name : name, completeCallback : (data:sp.SkeletonData)=>{
* if (data) {
* skeleton.animation = 'loop';
* skeleton.premultipliedAlpha = false;
* }
* }});
*/
loadRemoteSkeleton(config: {
view: any,
path: string,
name: string,
completeCallback: (data: sp.SkeletonData) => void,
isNeedCache?: boolean,
retain?: boolean
});
/**
* @description 加载动画
* @param config.bundle 可不填,默认为打开UIView时指向的Bundle
* @example
* action.loadSkeleton({url:"hall/vip/vipAction/vip_10",view:this,completeCallback:(data)=>{
* if ( data ){
* action.animation = "loop";
* action.loop = true;
* action.premultipliedAlpha = false;
* }
* }});
*/
loadSkeleton(config: { url: string, view: any, completeCallback: (data: sp.SkeletonData) => void, bundle?: BUNDLE_TYPE });
}
}
declare type BUNDLE_TYPE = string | cc.AssetManager.Bundle;
declare function require(any);
/**
* @description 发事件 参考framework/extentions/extentions dispatch 方法
* @param name
* @param data
*/
declare function dispatch(name: string, data?: any);
declare interface Date {
/**
* @description 格式当前时间
* @example
* let now = new Date();
* let str = now.format("yyyy:MM:dd hh:mm:ss"); //2019:11:07 10:19:51
* str = now.format("yyyy/MM/dd");//2019/11/07
* str = now.format("hh:mm:ss");//10:19:51
* */
format(format: string): string;
}
declare interface DateConstructor {
/**
* @description 返回当前时间的秒数
* @example
* Date.timeNow()
* */
timeNow(): number;
/**
* @description 返回当前时间的毫秒数
* @example
* Date.timeNowMillisecons()
* */
timeNowMillisecons(): number;
}
declare interface StringConstructor {
/**
* @description 格式化字符串
* @example
* String.format("{0}-->{1}-->{2}","one","two","three") | String.format("{0}-->{1}-->{2}",["one","two","three"])
* => "one-->two-->three"
* */
format(...args): string;
}
declare function md5(data: any): any;
declare interface LanguageData {
language: string;
}
declare type WebSocketType = "ws" | "wss";
/**
* @description 数据代理
* 如果是公共总合,name使用 td.COMMON_LANGUAGE_NAME
*/
declare interface LanguageDataSourceDelegate {
name: string;
data(language: string): LanguageData;
}
/**@description 提示代理 */
declare interface Tips {
/**
* @description tips提示
* @param msg 提示内容
*/
show(msg: string);
/**@description 预加载预置体 */
preloadPrefab();
finishShowItem(node: cc.Node);
}
/**@description 界面加载动画,web端在下载界面时,如果超过了一定时间,需要弹出动画,告诉用户当前加载界面的进度 */
declare interface UILoading {
/**
* @description 显示全屏幕加载动画
* @param delay 延迟显示时间 当为null时,不会显示loading进度,但会显示阻隔层 >0时为延迟显示的时间
*/
show(delay: number, name: string);
/**
* @description 更新进度,0-100
* @param progress 0-100
*/
public updateProgress(progress: number);
public hide();
/**@description 预加载预置体 */
public preloadPrefab();
}
declare interface IFullScreenAdapt {
/**@description 全屏幕适配 调用 */
onFullScreenAdapt(): void;
}
/**@description 提示弹出框配置 */
declare interface AlertConfig {
/**@description 用来标识弹出框,后面可指定tag进行关闭所有相同tag的弹出框 */
tag?: string | number,
/**@description 提示内容 richText只能二先1 */
text?: string,
/**@description 标题,默认为 : 温馨提示 */
title?: string,
/**@description 确定按钮文字 默认为 : 确定*/
confirmString?: string,
/**@description 取消按钮文字 默认为 : 取消*/
cancelString?: string,
/**@description 确定按钮回调 有回调则显示按钮,无回调则不显示*/
confirmCb?: (isOK: boolean) => void,
/**@description 取消按钮回调 有回调则显示按钮,无回调则不显示*/
cancelCb?: (isOK: boolean) => void,
/**@description 富文件显示内容 跟text只能二选1 */
richText?: string,
/**@description true 回调后在关闭弹出 false 关闭弹出框在回调 默认为 : false */
immediatelyCallback?: boolean,
/**@description 是否允许该tag的弹出框重复弹出,默认为true 会弹出同类型的多个 */
isRepeat?: boolean,
/**@description 用户自定义数据 */
userData?: any,
}
/**
* @description 处理游戏事件接口声明
* cc.game.EVENT_ENGINE_INITED
cc.game.EVENT_GAME_INITED
cc.game.EVENT_HIDE
cc.game.EVENT_RESTART
cc.game.EVENT_SHOW
*/
declare interface GameEventInterface {
/**@description 进入后台 cc.game.EVENT_HIDE*/
onEnterBackground();
/**
* @description 进入前台 cc.game.EVENT_SHOW
* @param inBackgroundTime 在后台运行的总时间,单位秒
*/
onEnterForgeground(inBackgroundTime: number);
}
declare interface Singleton<T> {
new(): T;
/**
*@description 单例统一实现
*/
Instance(): T;
}
/**@description 获取根据类型获取单列 */
declare function getSingleton<T>( SingletonClass : Singleton<T>):T;
declare namespace td {
export let COMMON_LANGUAGE_NAME: string;
export class EventComponent extends cc.Component {
/**
* @description 注册网络事件 ,在onLoad中注册,在onDestroy自动移除
* @param manCmd
* @param subCmd
* @param func 处理函数
* @param handleType 消息解析类型
* @param isQueue 是否加入队列
*/
registerEvent(manCmd: number, subCmd: number, func: (data: any) => void, handleType?: any, isQueue?: boolean): void;
/**
* 注册事件 ,在onLoad中注册,在onDestroy自动移除
* @param eventName
* @param func
*/
registerEvent(eventName: string, func: (data: any) => void): void;
/**
* @description 注册网络事件 ,在onLoad中注册,在onDestroy自动移除
* @param manCmd
* @param subCmd
* @param func 处理函数
* @param handleType 消息解析类型 如果不注册类型,返回的是服务器未进行解析的源数据,需要自己进行解包处理
* @param isQueue 是否加入队列
*/
addEvent(manCmd: number, subCmd: number, func: (data: any) => void, handleType?: any, isQueue?: boolean): void;
/**
* 注册事件 ,在onLoad中注册,在onDestroy自动移除
* @param eventName
* @param func
*/
addEvent(eventName: string, func: (data: any) => void): void;
/**
* @description 删除注册网络事件
* @param manCmd 主cmd
* @param subCmd 子cmd
*/
removeEvent(manCmd: number, subCmd: number): void;
/**
* @description 删除普通事件
* @param eventName 事件名
*/
removeEvent(eventName: string): void;
// protected bindingEvents(): void;
onLoad(): void;
onDestroy(): void;
}
export class AudioComponent extends EventComponent {
/**@description 音频控件资源拥有者,该对象由UIManager打开的界面 */
owner: UIView
/**@description 背景音乐音量 */
musicVolume: number;
/**@description 音效音量 */
effectVolume: number;
/**@description 音效开关 */
isEffectOn: boolean;
/**@description 背景音乐开关 */
isMusicOn: boolean;
/**@description 当前播放的背景音乐 */
curMusicUrl: string;
curBundle: BUNDLE_TYPE;
/**@description 存储 */
save(): void;
/**@description 停止 */
stopEffect(effectId: number = null): void;
stopAllEffects(): void;
stopMusic(): void;
playMusic(url: string, bundle: BUNDLE_TYPE, loop: boolean = true): Promise<{
url: string;
isSuccess: boolean;
}>;
playEffect(url: string, bundle: BUNDLE_TYPE, loop: boolean = false): Promise<number>;
onEnterBackground(): void;
onEnterForgeground(inBackgroundTime: number): void;
}
export class UIView extends EventComponent implements IFullScreenAdapt {
static getPrefabUrl(): string;
/**@description 当前传入参数,即通过UI管理器打开时的传入参数 */
get args(): any[];
/**指向当前View打开时的bundle */
bundle: BUNDLE_TYPE;
close(): void;
/**@description args为open代入的参数 */
show(args: any[]): void;
hide(): void;
/**@description 动画显示界面
*@param isOverrideShow 是否是重写show调用的,如果是重写show调用了,必将此参数设置为true,否则会产生死循环递归调用
*@param completeCallback 完成回调
*@example
* 示例: 通常在init/onLoad函数中调用 showWithAction,
* 但如果需要界面通过hide隐藏,而不是关闭界面时,下一次显示时
* 管理器直接调用了show,没有执行界面的打开动画,如果还需要界面打开动画
* 需要按如下方式重写show方法
* show( args : any[] ){
* super.show(args);
* this.showWithAction(true);
* //to do =>
* }
*/
showWithAction(isOverrideShow = false, completeCallback?: () => void): void;
/**@description 动画隐藏界面
*@param isOverrideHide 是否是重写hide调用的,如果是重写hide调用了,必将此参数设置为true,否则会产生死循环递归调用
*@param completeCallback 完成回调
*/
hideWithAction(completeCallback?: () => void): void;
/**@description 动画关闭界面
*@param completeCallback 完成回调
*/
closeWithAction(completeCallback?: () => void): void;
/**
* @description 启用物理返回键按钮
* @param isEnabled true 启用,
* @example 重写onKeyBack方法
*/
setEnabledKeyBack(isEnabled: boolean): void;
isEnabledKeyBack(): boolean;
onKeyUp(ev: cc.Event.EventKeyboard): void;
onKeyBack(ev: cc.Event.EventKeyboard): void;
audioHelper: AudioComponent;
enableFrontAndBackgroundSwitch: boolean;
onEnterForgeground(inBackgroundTime: number): void;
onEnterBackground(): void;
}
export class Language {
/**@description 添加数据代理 */
public addSourceDelegate(delegate: LanguageDataSourceDelegate);
/**@description 删除数据代理 */
public removeSourceDelegate(delegate: LanguageDataSourceDelegate);
/**
* @description 改变语言包
* @param language 语言包类型
*/
public change(language: string);
public get(args: (string | number)[]);
/**@description 获取语言包名 */
public getLanguage();
}
export class EventDispatcher {
/**
* @description 添加事件
* @param type 事件类型
* @param callback 事件回调
* @param target target
*/
public addEventListener(type: string, callback: ((data: any) => void) | string, target: any);
/**
* @description 移除事件
* @param type 事件类型
* @param target
*/
public removeEventListener(type: string, target: any);
/**
* @description 派发事件
* @param type 事件类型
* @param data 事件数据
*/
public dispatchEvent(type: string, data?: any);
}
export class ViewDynamicLoadData {
name: string;
constructor(name: string = null);
/**@description 添加动态加载的本地资源 */
addLocal(info: ResourceInfo, className: string = null): void;
/**@description 添加动态加载的远程资源 */
addRemote(info: ResourceInfo, className: string = null): void;
/**@description 清除远程加载资源 */
clear(): void;
};
export interface UIClass<T extends UIView> {
new(): T;
/**
*@description 视图prefab 地址 resources目录下如z_panels/WeiZoneLayer
*/
getPrefabUrl(): string;
}
export class UIManager {
/**@description 无主资源 */
garbage: ViewDynamicLoadData;
/**@description 驻留内存资源 */
retainMemory: ViewDynamicLoadData;
preload<T extends UIView>(uiClass: UIClass<T>, bundle: BUNDLE_TYPE): Promise<T>
/**
* @description open<T extends UIView>(config: { type: UIClass<T>, zIndex?: number, args?: any[] , delay?: number}) : Promise<T>
* @param config 配置信息
* @param config.type UIView
* @param config.zIndex 节点层级,默认为0
* @param config.args 传入的参数列表
* @param config.delay
* delay > 0 时间未加载界面完成显示加载动画,
* delay = 0 则不显示加载动画,但仍然会显示UILoading,在加载界面时阻挡玩家的触摸事件
* delay 其它情况以UILoading的默认显示时间为准
* @param config.name 界面名字,如 商城 首充
* @example 示例
* Manager.uiManager.open({type:GameLayer});
* Manager.uiManager.open({type:GameLayer,delay:ViewDelay.delay});
* Manager.uiManager.open({type:GameLayer,delay:ViewDelay.delay,zIndex:ViewZOrder.zero});
* Manager.uiManager.open({type:GameLayer,delay:ViewDelay.delay,zIndex:ViewZOrder.zero,args:["aa","bb"]});
*
* @description 弃用接口 open<T extends UIView>(uiClass: UIClass<T>, zIndex?: number, ...args: any[]): Promise<T>
* @param uiClass UIView
* @param zIndex 节点层级
* @param args 传入参数列表
*/
open<T extends UIView>(config: { type: UIClass<T>, bundle?: BUNDLE_TYPE, zIndex?: number, args?: any[], delay?: number, name?: string }): Promise<T>;
getCanvas(): cc.Node;
addChild(node: cc.Node, zOrder: number, adpater: IFullScreenAdapt = null): void;
/**@description 添加动态加载的本地资源 */
addLocal(info: ResourceInfo, className: string): void;
/**@description 添加动态加载的远程资源 */
addRemote(info: ResourceInfo, className: string): void;
close<T extends UIView>(uiClass: UIClass<T>): void;
close(className: string): void;
/**@description 关闭除传入参数以外的所有其它界面,不传入,关闭所有界面 */
closeExcept(views: (UIClass<UIView> | string | UIView)[]): void;
hide(className: string): void;
hide<T extends UIView>(uiClass: UIClass<T>): void;
getView(className: string): Promise<any>;
getView<T extends UIView>(uiClass: UIClass<T>): Promise<T>;
checkView(url: string, className: string);
isShow(className: string): boolean;
isShow<T extends UIView>(uiClass: UIClass<T>): boolean;
fullScreenAdapt(): void;
/*获取当前canvas的组件 */
getCanvasComponent(): cc.Component;
addComponent<T extends cc.Component>(type: { new(): T }): T;
addComponent(className: string): any;
removeComponent(component: string | cc.Component): void;
printViews(): void;
printCanvasChildren(): void;
printComponent(): void;
}
export class LocalStorage {
key: string;
getItem(key: string, defaultValue?: any): any;
setItem(key: string, value: string | number | boolean | object): void;
removeItem(key: string): void;
}
export class RemoteLoader {
loadImage(url: string, isNeedCache: boolean): Promise<cc.SpriteFrame>;
loadSkeleton(path: string, name: string, isNeedCache: boolean): Promise<sp.SkeletonData>;
/**@description 由主游戏控制器驱动,在下载远程资源时,设置一个上限下载任务数据,以免同一时间任务数量过大 */
update(): void;
}
export class AssetManager {
get remote(): RemoteLoader;
getBundle(bundle: BUNDLE_TYPE): cc.AssetManager.Bundle;
/**@description 加载bundle */
loadBundle(nameOrUrl: string, onComplete: (err: Error, bundle: cc.AssetManager.Bundle) => void): void;
/**@description 移除bundle */
removeBundle(bundle: BUNDLE_TYPE): void;
load(
bundle: BUNDLE_TYPE,
path: string,
type: typeof cc.Asset,
onProgress: (finish: number, total: number, item: cc.AssetManager.RequestItem) => void,
onComplete: (data: ResourceCacheData) => void): void;
loadDir(
bundle: BUNDLE_TYPE,
path: string,
type: typeof cc.Asset,
onProgress: (finish: number, total: number, item: cc.AssetManager.RequestItem) => void,
onComplete: (data: ResourceCacheData) => void): void;
/**
* @description 释放资源
* @param info 资源信息
*/
releaseAsset(info: ResourceInfo): void;
/**
* @description 资源引用计数加1
* @param info 资源信息
*/
retainAsset(info: ResourceInfo): void;
/**
* @description 添加常驻资源
* @param url
* @param data
* @param bundle
*/
addPersistAsset(url: string, data: cc.Asset, bundle: BUNDLE_TYPE): void;
}
/**
* @description 资源加载缓存数据
*/
export enum ResourceCacheStatus {
/**@description 无状态 */
NONE = 0,
/**@description 等待释放 */
WAITTING_FOR_RELEASE = 1,
}
/**@description 资源类型 */
export enum ResourceType {
/**@description 本地 */
Local = 0,
/**@description 远程资源 */
Remote = 1,
}
/**@description 资源信息 */
export class ResourceInfo {
url: string = "";
type: typeof cc.Asset = null;
data: cc.Asset | cc.Asset[] = null;
/**@description 是否常驻内存,远程加载资源有效 */
retain: boolean = false;
bundle: BUNDLE_TYPE = null;
/**@description 默认为本地资源 */
resourceType: ResourceType = ResourceType.Local;
}
export class ResourceCacheData {
/**@description 是否已经加载完成 */
isLoaded: boolean = false;
/**@description 加载完成数据
* cc.Prefab
* cc.SpriteAtlas
* cc.SpriteFrame
* cc.AudioClip
* cc.Font
* sp.SkeletonData
* cc.ParticleAsset
* cc.Texture2D
* cc.JsonAsset
* */
data: cc.Asset | cc.Asset[] = null;
info: ResourceInfo = new ResourceInfo();
status = ResourceCacheStatus.NONE;
/**@description 在加载过程中有地方获取,加载完成后再回调 */
getCb: ((data: any) => void)[] = [];
/**@description 完成回调,在资源正在加载过程中,又有其它地方调用加载同一个资源,此时需要等待资源加载完成,统一回调 */
finishCb: ((data: any) => void)[] = [];
public doGet(data): void;
public doFinish(data): void;
public get isInvalid(): boolean;
}
export class RemoteCaches {
/**
* @description 获取远程缓存数据
* @param type 远程奖状类型
* @param url 远程地址
*/
public get(url: string): ResourceCacheData;
public getSpriteFrame(url: string): ResourceCacheData;
public setSpriteFrame(url: string, data: any): cc.SpriteFrame;
set(url: string, data: ResourceCacheData): void;
retainAsset(info: ResourceInfo): void;
releaseAsset(info: ResourceInfo): void;
remove(url: string): void;
showCaches(): void;
}
export class CacheManager {
/**@description 远程资源缓存管理器 */
public get remoteCaches(): RemoteCaches;
getBundleName(bundle: BUNDLE_TYPE): string;
get(bundle: BUNDLE_TYPE, path: string, isCheck: boolean = true): ResourceCacheData;
set(bundle: BUNDLE_TYPE, path: string, data: ResourceCacheData): void;
/**
* @description
* @param bundle bundle
* @param path path
*/
remove(bundle: BUNDLE_TYPE, path: string): boolean;
removeWithInfo(info: ResourceInfo): boolean;
removeBundle(bundle: BUNDLE_TYPE): void;
/**
* @description 如果资源正在加载中,会等待资源加载完成后返回,否则直接返回null
* @param url
* @param type 资源类型
* @param bundle
*/
getCache<T extends cc.Asset>(url: string, type: { prototype: T }, bundle: BUNDLE_TYPE): Promise<T>;
/**
* @description 异步获取资源,如果资源未加载,会加载完成后返回
* @param url
* @param type
* @param bundle
*/
getCacheByAsync<T extends cc.Asset>(url: string, type: { prototype: T }, bundle: BUNDLE_TYPE): Promise<T>;
getSpriteFrameByAsync(urls: string[], key: string, view: UIView, addExtraLoadResource: (view: UIView, info: ResourceInfo) => void, bundle: BUNDLE_TYPE): Promise<{
url: string;
spriteFrame: cc.SpriteFrame;
isTryReload?: boolean;
}>;
/**@description 打印当前缓存资源 */
printCaches(): void;
}
export class ResolutionHelper {
isShowKeyboard: boolean;
/**@description 全屏适配 */
public fullScreenAdapt(node: cc.Node, adapter?: IFullScreenAdapt): void;
/**@description 是否需要做适配操作,当分辨率发生变化,只要ScreenAdaptType 不是None的情况 */
public get isNeedAdapt(): boolean;
public onLoad(node: cc.Node): void;
public onDestroy(): void;
/**@description 浏览器适配初始化 */
public initBrowserAdaptor(): void;
get isBrowser(): boolean;
}
export class NodePool {
constructor(name: string);
name: string;
/**
* @description 用来克隆的节点,在get时,如果发现对象池中不存在,会直接用此节点进行克隆
* 注意,设置的克隆对象会从父节点移除,但不会进行cleanup操作
* 在clear时,对该克隆节点进行释放操作
* */
cloneNode: cc.Node;
/**@description 当前对象池数据大小 */
get size(): number;
/**@description 销毁对象池中缓存的所有节点 */
clear(): void;
/**
* @description 向缓冲池中存入一个不需要的节点对象
* 这个函数会自动将目标节点从父节点移除,但不会进行 cleanup 操作
*
*/
put(obj: cc.Node): void;
/**
* @description 从对象池中取缓冲节点
* */
get(): cc.Node;
}
/**
* 对象池管理器
*/
export class NodePoolManager {
/**
* @description 创建对象池
* @param type 对象池类型
*/
createPool(type: string): NodePool;
/**
* @description 删除对象池
* @param type 对象池类型
* */
deletePool(type: string | NodePool): void;
/**
* @description 获取对象池
* @param type 对象池类型
* @param isCreate 当找不到该对象池时,会默认创建一个对象池
* */
getPool(type: string, isCreate = true): NodePool;
}
export class Alert {
preloadPrefab(): void;
show(config: AlertConfig): boolean;
/**
* @description 关闭当前显示的
* @param tag 可不传,关闭当前的弹出框,否则关闭指定tag的弹出框
*/
close(tag?: string | number)
/**@description 当前显示的弹出框是否是tag */
isCurrentShow(tag: string | number): boolean;
/**@description 获取当前显示弹出的配置 */
currentShow(tag?: string | number): AlertConfig;
/**@description 是否有该类型的弹出框 */
isRepeat(tag: string | number): boolean;
closeAll(): void;
finishAlert(): void;
}
export class Loading {
/**@description 显示超时回调 */
timeOutCb: () => void = null;
preloadPrefab(): void;
/**
* @description 显示Loading
* @param content 提示内容
* @param timeOutCb 超时回调
* @param timeout 显示超时时间
*/
show(content: string | string[], timeOutCb?: () => void, timeout?: number): this;
hide(): void;
}
export class LogicManager {
push(logicType: any): void;
onLoad(node: cc.Node): void;
onDestroy(node: cc.Node): void;
}
/**@description 游戏内数据的公共基类 */
export class GameData {
/**@description 当前的asset bundle name */
get bundle();
/**@description 清除数据 */
clear();
/**@description 游戏类型 */
gameType();
}
export class GameView extends UIView {
}
export class GlobalAudio extends AudioComponent {
playDialogOpen(): void;
playButtonClick(): void;
}
export class BundleConfig {
/**@description Bundle名 如:hall*/
bundle: string = "";
/**@description Bundle名 如:大厅 */
name: string = "";
index = 0;
/**@description 加载bundle完成后,发出的bundle事件 */
event: string;
/**@description 是否需要提示弹出框提示升级 */
isNeedPrompt: boolean = false;
/**
*
* @param name bundle名 如:大厅
* @param bundle Bundle名 如:hall
* @param index 游戏index,可根据自己需要决定需不需要
* @param event 加载bundle完成后,派发事件
* @param isNeedPrompt 是否需要弹出提示升级的弹出框
*/
constructor(name: string, bundle: string, index: number, event?: string, isNeedPrompt: boolean = false);
}
export class BundleManager {
/**@description 删除已经加载的bundle */
removeLoadedBundle(): void;
/**@description 删除所有加载子游戏的bundle */
removeLoadedGamesBundle(): void;
/**
* 外部接口 进入Bundle
* @param config 配置
*/
enterBundle(config: BundleConfig): void;
}
export class Reconnect {
static preloadPrefab(): void;
/**@description 是否启用 */
enabled: boolean;
constructor(service: CommonService);
async show(content?: string): void;
hide(): void;
hideNode(): void;
showNode(content: string): void;
}
export class CommonService implements GameEventInterface {
/**@description 进入后台的最大允许时间,超过了最大值,则进入网络重连 */
maxEnterBackgroundTime: number;
/**
* @description 连接网络
*/
connect(): void;
/**@description 网络重连 */
reconnect: Reconnect;
}
export class ServiceManager implements GameEventInterface {
/**
* @description 如果自己项目有多个网络Service,
* 可直接在这里添加,由ServiceManager统一处理
* */
onLoad(): void;
/**@description 网络事件调度 */
update(): void;
/**@description 主场景销毁,关闭所有连接 */
onDestroy(): void;
/**@description 关闭当前所有连接 */
close(): void;
/**@description 尝试重连 */
tryReconnect(service: CommonService, isShowTips: boolean = false): void;
/**@description 重连成功 */
onReconnectSuccess(service: CommonService): void;
/**@description 进入后台 cc.game.EVENT_HIDE*/
onEnterBackground();
/**
* @description 进入前台 cc.game.EVENT_SHOW
* @param inBackgroundTime 在后台运行的总时间,单位秒
*/
onEnterForgeground(inBackgroundTime: number);
}
export class NetManager {
constructor(name: string);
onLoad(node: cc.Node): void;
onDestroy(node: cc.Node): void;
/**@description 网络控制器注册 Controller<T>的子类 */
register(controllerType: any): void;
/**@description 添加网络控制组件 */
addNetControllers(): void;
/**@description 移除网络控制组件 */
removeNetControllers(): void;
}
export class FramewokManager {
/**@description 常驻资源指定的模拟view */
readonly retainMemory: ViewDynamicLoadData;
/**@description 语言包 */
readonly language: Language;
/**@description 事件派发器 */
readonly eventDispatcher: EventDispatcher;
/**@description 界面管理器 */
readonly uiManager: UIManager;
/**@description 本地仓库 */
readonly localStorage: LocalStorage;
/**@description 资源管理器 */
readonly assetManager: AssetManager;
/**@description 资源缓存管理器 */
readonly cacheManager: CacheManager;
/**@description 屏幕适配 */
readonly resolutionHelper: ResolutionHelper;
/**@description 对象池管理器 */
readonly nodePoolManager: NodePoolManager;
/**@description 小提示 */
readonly tips: Tips;
/**@description 界面加载时的全屏Loading,显示加载进度 */
readonly uiLoading: UILoading;
/**@description websocket wss 证书url地址 */
wssCacertUrl: string;
/**@description 提示框 */
readonly alert: Alert;
/**@description 加载动画 */
readonly loading: Loading;
/**@description 逻辑控制器管理器 */
readonly logicManager: LogicManager;
/**@description 游戏数据 自行设置 */
gameData: GameData;
/**@description 游戏网络控制器 自行设置 */
gameController: any;
/**@description 当前游戏视图 自行设置 */
gameView: GameView;
/**@description 全局音效播放组件 */
readonly globalAudio: GlobalAudio;
/**@description bundle管理器 */
readonly bundleManager: BundleManager;
readonly serviceManager: ServiceManager;
/**@description 大厅网络管理器 */
readonly hallNetManager: NetManager;
/**@description 全局网络管理器 */
readonly netManager: NetManager;
/**
* @description 把语言包转换成i18n.xxx形式
* @param param 语言包配置
* @param bundle bundle
* @example
* export let TANK_LAN_ZH = {
* language: cc.sys.LANGUAGE_CHINESE,
* data: {
* title: `坦克大战`,
* player: '单人模式 ',
* palyers: '双人模式',
* }
* }
* //以上是坦克大战的语言包,assetBundle为tankBattle
* Manager.makeLanguage("title","tankBattle"); //=> i18n.tankBattle.title 指向游戏特定的语言包
* Manager.makeLanguage("title"); //=> i18n.title 指向的大厅的公共语言包
*/
makeLanguage(param: string | (string | number)[], bundle: BUNDLE_TYPE = BUNDLE_RESOURCES): (string | number)[] | string;
/**
* @description 获取语言包
*/
getLanguage(param: string | (string | number)[], bundle?: BUNDLE_TYPE): string;
}
}
declare let Manager: td.FramewokManager;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
TypeScript
1
https://gitee.com/SMxiaoyao/QuickFramework.git
git@gitee.com:SMxiaoyao/QuickFramework.git
SMxiaoyao
QuickFramework
QuickFramework
2.4.3

搜索帮助

0d507c66 1850385 C8b1a773 1850385