oops-framework框架 之 启动流程(三)

news2024/10/7 10:23:34

引擎: CocosCreator 3.8.0

环境: Mac

Gitee: oops-game-kit


回顾


上篇博客中我们通过 oops-game-kit 模版构建了基础的项目,另外讲解了下assets目录结构和游戏配置文件的基本使用相关,详情内容可参考:

oops-framework框架 之模版创建项目

oops-framework框架 是由作者dgflash编写,基于CocosCreator3.x而实现的开源框架,为了方便大家更好的学习和使用该框架,作者很贴心准备了各种学习资料:

dgflash-哔哩视频

dgflash CSDN博客

dgflash-cocos论坛

Gitee dgflash项目仓库

注:oops-framework框架QQ群: 628575875

本篇博客将介绍下框架的启动流程和注意事项项目,用于了解和学习框架。


项目启动流程


oops-game-kitoops-framework 的脚本目录下: script/game/initialize 中,此处的代码主要主要项目的启动,主要代码文件有:

  • Initalize.ts 游戏初始化入口,用于加载公共资源和热更新

  • bll/InitRes.ts 用于初始化公共资源,也就是项目启动前加载的必备资源

  • view/LoadingViewComp.ts 游戏动态资源的加载

InitRes.ts 在项目启动时加载的必备资源路径在bundle/common中,资源越少,黑屏时间越短。

LoadingViewComp.ts 动态加载的资源路径在bundle/game 中,资源越多,Loading页面显示时间越长。

注:Loading页面就相当于对资源的预加载,避免游戏启动成功后进入各种页面显示卡顿。

我们分别说明下这几处代码的主要逻辑相关;

Initalize.ts

@ecs.register('Initialize')
export class Initialize extends ecs.Entity {
    protected init() {
        // 初始化游戏公共资源
        this.add(InitResComp);
    }
}

export class EcsInitializeSystem extends ecs.System {
    constructor() {
        super();

        this.add(new InitResSystem());
    }
}

项目采用的框架是 ECS 框架,也就是:Entity-Component-System(实体-组件-系统)框架。

更多内容可参考: ECS简介

这里我们只需要关注InitResComp即可,它会调用InitRes.ts进行项目启动是公共资源的初始化。


InitRes.ts

此处代码的主体是:

entityEnter(e: Initialize): void {
  var queue: AsyncQueue = new AsyncQueue();

  /** 加载远程资源配置 */
  this.loadBundle(queue);
  // 加载自定义资源
  this.loadCustom(queue);
  // 加载多语言包加载多语言包
  this.loadLanguage(queue);
  // 加载公共资源
  this.loadCommon(queue);
  // 加载游戏内容加载进度提示界面
  this.onComplete(queue, e);

  queue.play();
}

注:AsyncQueue是框架提供的一个异步队列处理,它支持将不同的任务添加到队列中按照顺序执行,在执行结束后通过next()执行下一个任务。

主要做的事情就如上面所说,我们看下大概的实现:

  • loadBundle() 加载Bundle资源配置
private loadBundle(queue: AsyncQueue) {
  queue.push(async (next: NextFunction, params: any, args: any) => {
    // 设置默认加载的外部资源包名
    oops.res.defaultBundleName = oops.config.game.bundleName;

    // 加载外部资源包
    if (oops.config.game.bundleEnable) {
      console.log("启用远程资源运行游戏");
      let bundleServer = oops.config.game.bundleServer;
      let bundleVersion = oops.config.game.bundleVersion;
      await oops.res.loadBundle(bundleServer, bundleVersion);
    }
    else {
      await oops.res.loadBundle(oops.config.game.bundleName);
    }
    next();
  });
}

// 框架提供的loadBundle主要用于加载资源包,支持远程和本地加载

框架会根据 resources/config 中的Bundle的配置,设置默认的Bundle名字,后期的资源动态加载都会在该Bundle目录中获取资源。

会根据Bundle配置数据检测:是远程加载还是本地加载Bundle资源相关

注: 框架中的动态资源不要放在resources中,除非您修改此处的默认Bundle名,但这样以后可能会不灵活

注:loadBundle 主要用于加载资源包,框架的底层实现调用的是assetManager.loadBundle


  • loadCustom() 加载自定义资源
/** 加载自定义内容(可选) */
private loadCustom(queue: AsyncQueue) {
  queue.push(async (next: NextFunction, params: any, args: any) => {
    // 加载多语言对应字体
    oops.res.load("language/font/" + oops.language.current, next);
  });
}

框架此处主要通过oops.res.load 加载了当前多语言的字体文件相关,主要用于后续多语言配置的铺垫。

注: 如果项目没有多语言配置相关,可以注释此处该接口

  • loadLanguage() 加载多语言相关
/** 加载化语言包(可选) */
private loadLanguage(queue: AsyncQueue) {
  queue.push((next: NextFunction, params: any, args: any) => {
    // 设置默认语言
    let lan = oops.storage.get("language");
    if (lan == null) {
      lan = "zh";
      oops.storage.set("language", lan);
    }

    // 加载语言包资源
    oops.language.setLanguage(lan, next);
  });
}

该接口会根据本地存储数据获取项目的默认语言,并通过setLanguage下载指定语言的内容,主要有:

  1. 对应的文本Json表,由Language Excel表转换而成
  2. 对应的图片纹理资源
  3. 对应的Spine骨骼动画资源

注: 如果项目没有多语言配置相关,可以注释此处该接口

  • loadCommon() 加载公共资源相关
private loadCommon(queue: AsyncQueue) {
  queue.push((next: NextFunction, params: any, args: any) => {
    oops.res.loadDir("common", next);
  });
}

此处的代码主要用于加载bundle/common路径下的资源,资源越小,黑屏时间越短;这块代码是最影响用户体验的地方。

注: 切记,不要在bundle/common路径下放置太多的资源

最后在所有的接口执行完毕后,会通过 onComplete调用 LoadingViewComp 组件的启动,用于加载项目所需要的动态资源。


LoadingViewComp.ts

项目进度条的实现,用于实现加载资源,避免项目不同功能页面显示卡顿的问题。

这里主要做了两件事:

  1. 加载项目数据表相关
private loadCustom() {
  // 加载游戏本地JSON数据的多语言提示文本
  this.data.prompt = oops.language.getLangByID("loading_load_json");

  return new Promise(async (resolve, reject) => {
    await JsonUtil.loadAsync(TableChapterList.TableName);
    await JsonUtil.loadAsync(TableCheckPoint.TableName);
    resolve(null);
  });
}

注: 多语言的配置表在 InitRes.ts的方法 loadLanguage 中已经加载,此处不需要; InitRes也用于处理热更新相关,如果报错,不进行提前加载,文本内容会显示异常

  1. 加载资源相关
private loadGameRes() {
  // 加载初始游戏内容资源的多语言提示文本
  this.data.prompt = oops.language.getLangByID("loading_load_game");
  // 加载的资源目录、进度回调、完成回调
  oops.res.loadDir("game", this.onProgressCallback.bind(this), this.onCompleteCallback.bind(this));
}

资源的路径主要在bundle/game中,资源目录和资源数目越多,加载越慢;但此处一般情况下不太影响用户的体验。

在所有的资源加载完成后,会调用如下LoadingViewComp.ts如下接口:

reset(): void {
  // 获取用户信息的多语言提示文本
  this.data.prompt = oops.language.getLangByID("loading_load_player");
  // 进入自定义游戏内容界面
  oops.gui.open(UIID.GAME_LOGIN);
  // 关闭加载界面
  oops.gui.remove(UIID.Loading);
}

注: oops.gui 用于控制不同页面的显示和隐藏相关,这些内容后面再详细介绍。

到这里截止,这是项目启动时候所进行的主要流程。


框架启动流程


oops是以单场景的样式运行项目的,框架以插件的形式存在。

框架提供的日志管理、游戏配置、时间管理、音乐管理、UI管理、资源管理、多语言、网络等模块相关需要在项目启动时完成初始化,我们才能通过Oops.ts调用相对应的模块。

项目启动的场景文件在assets目录中,叫做: main.scene
请添加图片描述

项目的主要启动文件位于root节点下Main.ts文件

// Root负责初始化框架的模块相关
export class Main extends Root {
  start() {
    if (DEBUG) profiler.showStats();
  }

  protected run() {
    smc.initialize = ecs.getEntity<Initialize>(Initialize);
  }

  protected initGui() {
    oops.gui.init(UIConfigData);
  }

  protected initEcsSystem() {
    oops.ecs.add(new EcsInitializeSystem());
  }
}

该文件通过ECS框架主要做的事情:

  1. 获取 Initalize 实体用于调用Initialize.ts 对项目进行初始化
  2. 获取UIConfig 页面配置数据,完成对GUI Layer页面的初始化

继承的Root 主要用于完成框架各种模块的初始化。


Root.ts

它用于作为框架显示层的根结点相关,主要管理两种类型的节点:

  • game 游戏层节点,相当于游戏世界中的地图
  • gui 界面层节点,相当于游戏世界上方显示的UI层

主要逻辑代码:

  1. 通过CocosCreator的生命周期onLoad函数调用 resources/config.json 开始初始化
onLoad() {
  if (!isInited) {
    isInited = true;
    console.log(`Oops Framework v${version}`);
    this.enabled = false;

    let config_name = "config";
    // 动态加载resources/config.json配置文件,进行初始化
    oops.res.load(config_name, JsonAsset, () => {
      var config = oops.res.get(config_name);
      oops.config.btc = new BuildTimeConstants();
      oops.config.query = new GameQueryConfig();
      oops.config.game = new GameConfig(config);
      // 初始化服务器地址
      oops.http.server = oops.config.game.httpServer; 
      // 设置请求超时时间
      oops.http.timeout = oops.config.game.httpTimeout;                                    
      // 初始化本地存储加密key和iv
      oops.storage.init(oops.config.game.localDataKey,oops.config.game.localDataIv);  
      // 设置游戏帧率
      game.frameRate = oops.config.game.frameRate;                                         
      this.enabled = true;
      this.init();
      this.run();
    });
  }
}
  1. 调用 init方法完成框架音频管理、屏幕适配、游戏显示隐藏的初始化,主要代码:
protected init() {
  // 创建持久根节点
  this.persistRootNode = new Node("PersistRootNode");
  director.addPersistRootNode(this.persistRootNode);
  // 创建音频模块
  oops.audio = this.persistRootNode.addComponent(AudioManager);
  oops.audio.load();
  // 创建时间模块
  oops.timer = this.persistRootNode.addComponent(TimerManager)!;
	// 多语言相关
  oops.language = new LanguageManager();
  // 游戏层节点构建
  oops.game = new GameManager(this.game);
  // 界面层节点构建
  oops.gui = new LayerManager(this.gui);
  this.initGui();
	// ECS框架的初始化
  this.initEcsSystem();
  oops.ecs.init();

  // 游戏显示事件
  game.on(Game.EVENT_SHOW, () => {
    oops.log.logView("【系统】游戏前台显示");
    oops.timer.load();     // 平台不需要在退出时精准计算时间,直接暂时游戏时间
    oops.audio.resumeAll();
    director.resume();
    game.resume();
    oops.message.dispatchEvent(EventMessage.GAME_ENTER);
  });

  // 游戏隐藏事件
  game.on(Game.EVENT_HIDE, () => {
    oops.log.logView("【系统】游戏切到后台");
    oops.timer.save();     // 平台不需要在退出时精准计算时间,直接暂时游戏时间
    oops.audio.pauseAll();
    director.pause();
    game.pause();
    oops.message.dispatchEvent(EventMessage.GAME_EXIT);
  });

  // 游戏尺寸修改事件
  var c_gui = this.gui.addComponent(GUI)!;
  if (sys.isMobile == false) {
    screen.on("window-resize", () => {
      oops.log.logView("【系统】游戏画布尺寸变化");
      c_gui.resize();
      oops.message.dispatchEvent(EventMessage.GAME_RESIZE);
    }, this);

    screen.on("fullscreen-change", () => {
      oops.log.logView("【系统】游戏全屏显示");
    }, this);
  }

  screen.on("orientation-change", () => {
    oops.log.logView("【系统】游戏旋转屏幕");
  }, this);
}

主要做的事情:

  • 构建常驻根节点,用于初始化音频模块和时间管理模块
  • 构建游戏层、界面层根节点
  • 初始化ECS实体组件系统框架
  • 监听项目的显示和隐藏,以停止或恢复声音等处理
  • 添加GUI屏幕适配组件

注:这里便是框架初始化的主体部分

  1. 在框架完成初始化后,就会调用Main.ts下的run() 方法,对项目进行初始化
protected run() {
  smc.initialize = ecs.getEntity<Initialize>(Initialize);
}

注: 项目启动的时候黑屏的那段时间也是包含框架初始化逻辑相关的,大家了解即可。

最后,祝大家学习生活工作愉快!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1523052.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

「黄钊的AI日报·第三季」正式发布!

每天5条AI内容点&#xff1a;不是新闻汇总&#xff0c;而是站在11年AI产品经理的视角&#xff0c;将原AI信息中的干货认知&#xff0c;提炼成我自己的文字、展示“what I see”。 做社群“AI产品经理大本营”6年以来&#xff0c;我都是在非常用心的输出AI干货&#xff1b;这份“…

html5使用Websocket

html5使用Websocket 前言1、html5中的websocket2、创建一个 WebSocket 对象3、监听 WebSocket 连接事件4、监听 WebSocket 收到消息事件5、监听 WebSocket 关闭事件6、 监听 WebSocket 出错事件7、发送消息8、整体代码 前言 在即时通讯的交互方式中websocket是一个很使用的方式…

C/C++整数和浮点数在内存中存储

1. 整数在内存中的存储&#xff1a; 整数的2进制表⽰⽅法有三种&#xff0c;即 原码、反码和补码 三种表⽰⽅法均有符号位和数值位两部分&#xff0c;符号位都是⽤0表⽰“正”&#xff0c;⽤1表⽰“负”&#xff0c;⽽数值位最 ⾼位的⼀位是被当做符号位&#xff0c;剩余的都是…

蓝桥杯2022年第十三届省赛真题-GCD

solution1(通过60%) 观察数据发现,最大公约数为abs(a-b) 当abs(a-b) > min(a, b)时&#xff0c;最小增量为g - min(a, b) #include<iostream> #include<algorithm>typedef long long LL;using namespace std; int main(){LL a, b, g, k -1, t1, t2;scanf(&qu…

Django验证码(二)

一、生成图片 1.1、说明 通过pillow模板库生成图片,步骤如下 安装pillow模板建立 生成验证码内容 方法建立 生成验证码颜色 方法建立 生成验证码 方法1.2、需要安装 Pillow 库 pip install Pillow==9.3.01.3、生成验证码内容 import randomdef random_str(length=4):"…

5 分钟小工具:使用 dive 分析 docker 镜像

需求 拿到一个镜像之后&#xff0c;我想知道&#xff1a; 分层查看镜像里都有哪些文件各层使用了什么命令构建的这个镜像镜像里比较大的文件有哪些&#xff08;可能需要优化&#xff09; dive 工具介绍 dive 工具可以做这些分析。dive 的 github 地址是 wagoodman/dive&…

由浅到深认识C语言(13):共用体

该文章Github地址&#xff1a;https://github.com/AntonyCheng/c-notes 在此介绍一下作者开源的SpringBoot项目初始化模板&#xff08;Github仓库地址&#xff1a;https://github.com/AntonyCheng/spring-boot-init-template & CSDN文章地址&#xff1a;https://blog.csdn…

S4 Hana SD -信贷管理 - 03

6. 自动信贷控制及检查规则 6.1 自动信贷控制与检查规则简介 自动信用控制将针对同一信用控制范围的不同的客户风险类别和信贷组执行不同的信用控制政策。对于ECC系统而言,无需单独设置检查规则,可在自动信贷控制进行设置即可,如图1-5-2。在S4 HANA版本中,自动信贷控制和检…

Day39:安全开发-JavaEE应用SpringBoot框架Actuator监控泄漏Swagger自动化

目录 SpringBoot-监控系统-Actuator SpringBoot-接口系统-Swagger 思维导图 Java知识点&#xff1a; 功能&#xff1a;数据库操作&#xff0c;文件操作&#xff0c;序列化数据&#xff0c;身份验证&#xff0c;框架开发&#xff0c;第三方组件使用等. 框架库&#xff1a;MyB…

[沉淀之华] 自研基于SpringBoot Mybaits 构建低代码数据治理脚手架分享:涵盖数据同步、数据比对、数据归档、数据恢复为一体

文章目录 成果演示背景整体能力功能描述相关细节安装使用 成果演示 Github地址&#xff1a;数据治理脚手架 wiki&#xff1a;kg-ctl-core使用文档 背景 为什么要做这个&#xff1f; 一个老生常谈且不得不谈问题&#xff1a;随着业务日益发展&#xff0c;如果不做数据迁移&…

LabVIEW湍流等离子体束热效率优化

LabVIEW湍流等离子体束热效率优化 利用LabVIEW虚拟仪器技术&#xff0c;对湍流等离子体束的热效率进行了实时监测与优化&#xff0c;提高其在材料处理领域的应用效率和精度。通过双进气湍流等离子体发生器&#xff0c;实现了在不同工作参数下对热效率的实时在线监测&#xff0…

JVM学习-JVM的自动优化

目录 1.语法糖 1.1默认构造器 1.2自动拆装箱 1.3泛型集合取值 1.4可变参数实现 1.5 foreach循环 1.6 switch配合String使用 1.7 switch配合枚举使用​编辑 1.8 try-with-resources 1.9方法重写的桥接方法 2.运行时优化 2.1分层优化以及逃逸分析 2.2方法内联 2.3字段优化 JVM会…

在Linux/Ubuntu/Debian中使用windows应用程序/软件

Wine 是一个兼容层&#xff0c;允许你在类 Unix 操作系统&#xff08;包括 Ubuntu&#xff09;上运行 Windows 应用程序。 以下是在 Ubuntu 上安装和使用 Wine 的基本步骤&#xff1a; 在 Ubuntu 上安装 Wine&#xff1a; 更新软件包列表&#xff1a; 打开终端并运行以下命令以…

Maya自定义工具架

有时候我们需要自己定义工具架上的内容&#xff0c;比如将一个工具放到工具架上&#xff0c;或者删除一个工具 添加一个工具 例如我们想在多边形建模栏位上添加一个分离按钮&#xff0c;默认 1 先切换到想要添加的工具架栏位 2 打开菜单&#xff0c;找到我们想添加的工具 …

重新认识BIO、NIO、IO多路复用、Select、Poll、Epollo它们之间的关系

目录 一、背景 二、名词理解 &#xff08;1&#xff09;BIO &#xff08;2&#xff09;NIO &#xff08;3&#xff09;IO多路复用 &#xff08;4&#xff09;Select、Poll、Epollo 三、他们之间的关系总结 一、背景 最近又在学习网络IO相关知识&#xff0c;对我们常说的…

GAMES104-现代游戏引擎 1

主要学习重点还是面向就业&#xff0c;重点复习八股和算法 每天早上八点到九点用来学习这个课程 持续更新中... 第一节 游戏引擎导论 第二节 引擎架构分层

[CTF]-Web:部分题目WP

file_include&#xff1a; 爆破 http://61.147.171.105:57268/?filenamephp://filter/convert.iconv.a.b/resourceflag.php

设计模式 -- 2:策略模式

目录 总结部分&#xff1a;策略模式的优点部分代码部分 总结部分&#xff1a; 策略模式和简单工厂模式很像 区别在于 简单工厂模式 需求的是由工程创造的类 去给客户直接答案 而策略模式在于 我有主体 一个主体 根据策略的不同来进行不同的计算 我的主体就负责收钱 然后调度相…

【Qt问题】vs里直接打开qt项目的ui会崩溃

问题描述&#xff1a; 当我用VS2019开发Qt的时候&#xff0c;在VS编译器里要用到Qt的ui设计&#xff0c;但是双击打开发现直接就崩溃了。 解决办法&#xff1a; 崩溃的原因很简单&#xff0c;是因为VS默认用的qt designer打开&#xff0c;所以会崩溃&#xff0c;我们右键单击…

【运维】StarRocks数据迁移到新集群(针对于集群互通、不互通的情况)

文章目录 一. 迁移整体思路1. 对于新旧集群互通的情况2. 对于新旧集群不互通的情况 二、迁移过程&#xff08;两个集群互通的情况&#xff09;1. 备份过程1.1. 通过mysqlclient与starrocks进行关联1.2. 创建仓库与minio建立联系1.3. 备份数据到minio 2. 迁移过程2.1. 通过mysql…