找物源码导读Cocos Creator 3.8 · assets/scripts
0%
已读 0 / 424
目录— 个文件
目录加载中…
…/scripts/bridge/GameEntry.ts
1import { _decorator } from 'cc';
2import { ProcudureEnum } from './procedure/ProcudureEnum';
3import { Framework } from '../framework/Framework';
4import { FrameworkEntry } from '../framework/FrameworkEntry';
5import { Runtime } from '../runtime/Runtime';
6import { ResourceBundleLoaderFindObjects } from '../framework/core/resource/findobjects/ResourceBundleLoaderFindObjects';
7import { GetOSSRootPath, ResourceConfigFindObjects as FrameworkResourceConfigFindObjects } from '../framework/core/resource/findobjects/ResourceConfigFindObjects';
8import { ConfigDataMap, ConfigName } from './config/ConfigDefine';
9import { ResourceConfig, ResourceConfigFindObjects } from './resource/ResourceConfig';
10import { UIPanelReportConfig } from './ui/UIPanelReportConfig';
11import { SdkReport } from "./sdk/SdkReport";
12import { SdkGameData } from './sdk/SdkGameData';
13import { ServerConfig } from './server/ServerConfig';
14import { PackageData, PackageDataMap, PackageType, DefaultPackageType } from './package/PackageDefine';
15import { AB_ACTIVE_EXPERIMENTS, ABExperimentKey } from './ab/ABDefine';
16
17// 导入项目流程触发原注册装饰器,早于 FrameworkEntry 初始化管理器。
18import './procedure/ProcedureLoading';
19import './procedure/ProcedureInit';
20import './procedure/ProcedureLobby';
21import './procedure/ProcedureGame';
22
23const { ccclass } = _decorator;
24
25// 保留原 ccclass 和脚本 UUID,场景继续只挂载这个项目入口。
26@ccclass('GameEntry')
27export class GameEntry extends FrameworkEntry {
28 onLoad(): void {
29 // 固定登录流程执行前提供连接地址,不在框架内保存项目默认域名。
30 this.ConfigureServer();
31 // 在父类初始化 SDK/登录之前提供项目数据访问;父类原启动顺序保持不变。
32 this.ConfigureSdk();
33 super.onLoad();
34 }
35
36 /** 由项目选择服务器,通信与登录流程仍由框架负责。 */
37 protected ConfigureServer(): void {
38 Framework.Tsrpc.SetServerUrl(ServerConfig.ServerUrl);
39 }
40
41 /** 只接入项目数据与埋点规则;配置容器及固定启动顺序由框架维护。 */
42 protected ConfigureSdk(): void {
43 Framework.Sdk.SetGameData(SdkGameData);
44 Framework.Sdk.SetReport(SdkReport);
45 }
46
47 protected ConfigurePackage(): void {
48 // 枚举自身提供编号到名称的映射,避免维护第二份名单。
49 Framework.Package.SetPackageConfig(PackageDataMap, PackageType, DefaultPackageType);
50 }
51
52 protected ConfigureUI(): void {
53 // 项目只提供具体面板与埋点场景的对应关系,生命周期上报仍由框架负责。
54 Framework.UI.SetPanelReportScenes(UIPanelReportConfig);
55 }
56
57 protected ConfigureAB(): void {
58 // 暂兼容历史发行开关,待对应业务确认后迁移;框架 AB 不感知包或玩法。
59 const flags = Framework.Package.GetCurrentPackageData<PackageData>().featureFlags;
60 const experiments = AB_ACTIVE_EXPERIMENTS.filter(def => {
61 if (def.key === ABExperimentKey.MainlineLevelV1) {
62 return flags?.enableMainlineAB === true;
63 }
64 // 热点分组仅对参测发行包注册,保留远端实验资格规则。
65 if (def.key === ABExperimentKey.HotspotLevelV1) {
66 return flags?.enableHotspotAB === true;
67 }
68 return true;
69 });
70 Framework.AB.SetExperiments(experiments);
71 }
72
73 protected ConfigureResource(): void {
74 // 直接交给框架同一个对象,随后编辑器和发行包在此对象上覆盖。
75 Framework.Res.SetConfig(ResourceConfig);
76 // 寻物专项配置同样只传原引用,通用资源管理器不感知寻物字段。
77 FrameworkResourceConfigFindObjects.SetConfig(ResourceConfigFindObjects);
78 // 只创建并选择寻物加载器,不执行 Init;编辑器/发行包同步后才初始化。
79 Framework.Res.SetBundleLoader(new ResourceBundleLoaderFindObjects(
80 ConfigName.BundleVersionWechat,
81 ConfigName.BundleVersionWeb,
82 ));
83 }
84
85 protected ConfigureConfig(): void {
86 // 清单只在 Bridge 定义一次;目录函数在真正请求时读取最终版本,不提前拼接。
87 // 包级可选表在 Bridge 筛选,通用加载器不依赖具体玩法开关。
88 const flags = Framework.Package.GetCurrentPackageData<PackageData>().featureFlags;
89 const configs = ConfigDataMap.filter(data => !data.FeatureFlagKey || flags?.[data.FeatureFlagKey] === true);
90 Framework.Config.SetStartupConfigs(configs, () => `${GetOSSRootPath()}${Framework.Res.Config.BundleVersion}/`);
91 }
92
93
94
95 protected StartGame(): void {
96 // 固定登录与存档准备由父类完成,这里仅选择当前游戏的初始流程。
97 Framework.Procedure.StartProcedure(ProcudureEnum.Init);
98 }
99
100 protected OnGameShow(): void {
101 // 先执行公共 SDK/音频恢复,再按原顺序恢复项目系统。
102 super.OnGameShow();
103 // 前台沿用当前存档,不重新登录或拉取替换玩家数据。
104 Runtime.Daily.RefreshDay();
105 Runtime.DailyChallenge.RefreshParticipationTracking();
106 Runtime.Currency.HandleAppShow();
107 }
108}
讲解109 行
游戏入口人工通读

GameEntry.ts

项目唯一入口脚本,挂在启动场景根节点上并继承 FrameworkEntry。它在父类初始化前补上服务器地址与项目埋点数据,父类 onLoad 再按固定顺序回调六个 Configure 钩子注入包、资源、UI、配置与实验,最后由 StartGame 选择初始化流程。

先看 onLoad 中 ConfigureServer、ConfigureSdk、super.onLoad 的先后关系,再对照 FrameworkEntry.onLoad 里 ConfigurePackage 到 ConfigureAB 的调用顺序,最后读 StartGame 与 OnGameShow。

特殊处理与易错点

18注释导入项目流程触发原注册装饰器,早于 FrameworkEntry 初始化管理器。
26注释保留原 ccclass 和脚本 UUID,场景继续只挂载这个项目入口。
27注释GameEntry:由项目选择服务器,通信与登录流程仍由框架负责。
28方法先调用 ConfigureServer 与 ConfigureSdk 注入项目数据,再执行父类 onLoad…
30注释固定登录流程执行前提供连接地址,不在框架内保存项目默认域名。
32注释在父类初始化 SDK/登录之前提供项目数据访问;父类原启动顺序保持不变。
37方法把 ServerConfig.ServerUrl 写入 Framework.Tsrpc,作为登录前的服务器连…
42方法将项目 SdkGameData 与 SdkReport 交给 Framework.Sdk,使框架存档读取与埋…
47方法把 PackageDataMap、PackageType 与 DefaultPackageType 注册给框…
49注释枚举自身提供编号到名称的映射,避免维护第二份名单。
52方法把 UIPanelReportConfig 交给 Framework.UI,作为面板开关时场景埋点的映射表。
54注释项目只提供具体面板与埋点场景的对应关系,生命周期上报仍由框架负责。
57方法读取当前包 featureFlags,按主线与热点开关过滤实验清单,再把结果交给 Framework.AB …
59注释暂兼容历史发行开关,待对应业务确认后迁移;框架 AB 不感知包或玩法。
65注释热点分组仅对参测发行包注册,保留远端实验资格规则。
73方法把两个项目资源对象原引用交给框架,并以两张 md5 表名创建寻物加载器,此处不执行 Init。
75注释直接交给框架同一个对象,随后编辑器和发行包在此对象上覆盖。
77注释寻物专项配置同样只传原引用,通用资源管理器不感知寻物字段。
79注释只创建并选择寻物加载器,不执行 Init;编辑器/发行包同步后才初始化。
85方法按包开关过滤 ConfigDataMap,再连同 GetOSSRootPath 拼出的目录回调一起交给 Fr…
88注释清单只在 Bridge 定义一次;目录函数在真正请求时读取最终版本,不提前拼接。 包级可选表在 Bridge 筛选,通用加载器不依赖具体玩法开关。
95方法调用 Framework.Procedure.StartProcedure 并传入 ProcudureEnu…
97注释固定登录与存档准备由父类完成,这里仅选择当前游戏的初始流程。
100方法先调用父类恢复 SDK 生命周期与音频,再刷新每日数据、每日挑战参与追踪与货币恢复倒计时。
102注释先执行公共 SDK/音频恢复,再按原顺序恢复项目系统。
104注释前台沿用当前存档,不重新登录或拉取替换玩家数据。