@kkarum/framework 2.3.20 → 2.3.22

package/docs/FRAMEWORK_USAGE.md

@@ -45,6 +45,7 @@ export class ShopLayerController extends FW.LayerController {
 - 事件绑定走 `LayerController.registerEvent()`、`cc()`、`fw()` 或 `FW.Entry.evtMgr`。
 - 定时器走 `FW.Entry.timeMgr`。
 - 可取消/带重试异步流程走 `FW.Entry.promiseMgr`。
+- 所有的Layer.ts都不需要挂载到对应的节点或预制体上。
 
 ## 新增业务 Bundle
 
@@ -52,12 +53,13 @@ export class ShopLayerController extends FW.LayerController {
 
 ```text
 assets/<bundle>/
-  config/<Bundle>AssetConfig.ts
-  data/<Bundle>Data.ts
-  logic/<Bundle>Logic.ts
-  registry/<Bundle>Registry.ts
-  ui/<Feature>/<Feature>LayerController.ts
-  prefab/<Feature>Layer.prefab
+  script/config/<Bundle>AssetConfig.ts
+  script/data/<Bundle>Data.ts
+  script/logic/<Bundle>Logic.ts
+  script/<Bundle>Registry.ts
+  script/controller/<Feature>/<Feature>LayerController.ts
+  script/layer/<Feature>/<Feature>Layer.ts
+  res/layer/<Feature>Layer.prefab
 ```
 
 注册类示例：
@@ -181,7 +183,9 @@ export class ShopLayerController extends FW.LayerController {
   isRepeatOpen = false;
 
   get layerAssetProperty(): FW.AssetProperty {
-    return this.getConfig<ShopAssetConfig>().preLoad.prefab["ShopLayer"] as FW.AssetProperty;
+    return this.getConfig<ShopAssetConfig>().preLoad.prefab[
+      "ShopLayer"
+    ] as FW.AssetProperty;
   }
 
   onInit(args?: { tab?: string }) {
@@ -238,17 +242,21 @@ this.fw("SHOP_GOODS_CHANGED", this.renderGoods);
 
 ```ts
 this.registerEvent({
-  CCEvent: [{
-    target: buyButton,
-    eventName: cc.Node.EventType.TOUCH_END,
-    responseInterval: 500,
-    cb: this.onBuyClick,
-  }],
-  FWEvent: [{
-    eventName: "SHOP_REFRESH",
-    responseInterval: 200,
-    cb: this.onRefresh,
-  }],
+  CCEvent: [
+    {
+      target: buyButton,
+      eventName: cc.Node.EventType.TOUCH_END,
+      responseInterval: 500,
+      cb: this.onBuyClick,
+    },
+  ],
+  FWEvent: [
+    {
+      eventName: "SHOP_REFRESH",
+      responseInterval: 200,
+      cb: this.onRefresh,
+    },
+  ],
 });
 ```
 
@@ -257,9 +265,13 @@ this.registerEvent({
 ## 定时器
 
 ```ts
-const schedule = FW.Entry.timeMgr.scheduleOnce(() => {
-  this.refreshGoods();
-}, 1, this);
+const schedule = FW.Entry.timeMgr.scheduleOnce(
+  () => {
+    this.refreshGoods();
+  },
+  1,
+  this,
+);
 
 FW.Entry.timeMgr.schedule(
   () => this.tick(),
@@ -277,16 +289,19 @@ FW.Entry.timeMgr.unSchedule(this);
 ## Promise
 
 ```ts
-const proxy = FW.Entry.promiseMgr.execute<string>((resolve, reject, signal) => {
-  // 异步操作
-  signal.addEventListener("abort", () => {
-    // 清理
-  });
-}, {
-  timeout: 10000,
-  retryCount: 3,
-  retryInterval: 2,
-});
+const proxy = FW.Entry.promiseMgr.execute<string>(
+  (resolve, reject, signal) => {
+    // 异步操作
+    signal.addEventListener("abort", () => {
+      // 清理
+    });
+  },
+  {
+    timeout: 10000,
+    retryCount: 3,
+    retryInterval: 2,
+  },
+);
 
 const result = await proxy.promise;
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kkarum/framework",
-  "version": "2.3.20",
+  "version": "2.3.22",
   "description": "cocoscreator 2.x mvc framework",
   "main": "index.js",
   "keywords": [