@kkarum/framework 2.3.23 → 2.3.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,7 @@ Codex / AI 工具生成本项目业务代码时必须遵守：
|
|
|
8
8
|
- `LayerController` 不查找节点或组件；节点/组件引用定义在对应 `FW.Layer` 中，节点用 `FWPropertyNode`，组件用 `FWPropertyComponent`，变量名与节点名一致。
|
|
9
9
|
- 默认不要在业务层调用 `invoke()`，除非用户明确要求。
|
|
10
10
|
- 新增业务 bundle 必须提供 `FW.Registry` 注册表，并在文件末尾调用 `FW.Framework.addRegistry()`；`bundleName` 和 `addRegistry()` 的 key 必须一致，统一使用小写 bundle 名。
|
|
11
|
+
- 不需要require对应的Registry
|
|
11
12
|
|
|
12
13
|
Registry 示例：
|
|
13
14
|
|
|
@@ -42,23 +43,23 @@ FW.Framework.addRegistry("register", RegisterRegistry);
|
|
|
42
43
|
|
|
43
44
|
## 主要模块
|
|
44
45
|
|
|
45
|
-
| 模块
|
|
46
|
-
|
|
|
47
|
-
| `FW.Registry`
|
|
48
|
-
| `FW.FrameworkBase`
|
|
49
|
-
| `FW.Logic`
|
|
50
|
-
| `FW.Data`
|
|
51
|
-
| `FW.AssetConfig`
|
|
52
|
-
| `FW.LayerController`
|
|
53
|
-
| `FW.Entry.resMgr`
|
|
54
|
-
| `FW.Entry.layerMgr`
|
|
55
|
-
| `FW.Entry.uiMgr`
|
|
56
|
-
| `FW.Entry.evtMgr`
|
|
57
|
-
| `FW.Entry.timeMgr`
|
|
58
|
-
| `FW.Entry.promiseMgr` | 可取消、超时、重试的 Promise
|
|
59
|
-
| `FW.Entry.socketMgr`
|
|
60
|
-
| `FW.Entry.objectMgr`
|
|
61
|
-
| `FW.Entry.taskMgr`
|
|
46
|
+
| 模块 | 说明 |
|
|
47
|
+
| --------------------- | --------------------------------------------------- |
|
|
48
|
+
| `FW.Registry` | bundle 注册表，声明 Logic/Data/Config/Sender/Handle |
|
|
49
|
+
| `FW.FrameworkBase` | 业务基类，提供依赖获取、性能记录和错误包装 |
|
|
50
|
+
| `FW.Logic` | 业务流程 |
|
|
51
|
+
| `FW.Data` | 业务数据 |
|
|
52
|
+
| `FW.AssetConfig` | 资源配置 |
|
|
53
|
+
| `FW.LayerController` | UI Layer 控制器 |
|
|
54
|
+
| `FW.Entry.resMgr` | bundle 和资源加载/释放 |
|
|
55
|
+
| `FW.Entry.layerMgr` | UI Layer 打开、关闭、队列和栈 |
|
|
56
|
+
| `FW.Entry.uiMgr` | UI 事件注册、节点查找、按钮状态 |
|
|
57
|
+
| `FW.Entry.evtMgr` | 框架事件总线 |
|
|
58
|
+
| `FW.Entry.timeMgr` | 游戏生命周期定时器 |
|
|
59
|
+
| `FW.Entry.promiseMgr` | 可取消、超时、重试的 Promise |
|
|
60
|
+
| `FW.Entry.socketMgr` | Socket 连接管理 |
|
|
61
|
+
| `FW.Entry.objectMgr` | 对象池 |
|
|
62
|
+
| `FW.Entry.taskMgr` | 分帧任务 |
|
|
62
63
|
|
|
63
64
|
## 推荐业务结构
|
|
64
65
|
|
|
@@ -66,14 +67,13 @@ FW.Framework.addRegistry("register", RegisterRegistry);
|
|
|
66
67
|
|
|
67
68
|
```text
|
|
68
69
|
assets/<bundle>/
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
prefab/<Feature>Layer.prefab
|
|
70
|
+
script/config/<Bundle>AssetConfig.ts
|
|
71
|
+
script/data/<Bundle>Data.ts
|
|
72
|
+
script/logic/<Bundle>Logic.ts
|
|
73
|
+
script/<Bundle>Registry.ts
|
|
74
|
+
script/controller/<Feature>/<Feature>LayerController.ts
|
|
75
|
+
script/layer/<Feature>/<Feature>Layer.ts
|
|
76
|
+
res/layer/<Feature>Layer.prefab
|
|
77
77
|
```
|
|
78
78
|
|
|
79
79
|
命名必须保留框架后缀，例如 `ShopLogic`、`ShopData`、`ShopAssetConfig`、`ShopSender`、`ShopHandle`。框架会根据类名和 bundle 名自动推断依赖。
|