整理代码删除一些不必要的脚本逻辑等

fkworld · Dec 25, 2019 · 9829e92 · 9829e92
1 parent 940a019
commit 9829e92
Show file tree

Hide file tree

Showing 35 changed files with 447 additions and 685 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
-# cocos游戏轻量级框架
+# cocos 轻量级游戏框架
 [![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
 [![blog](https://img.shields.io/badge/blog-game--develop--road-yellow.svg)](https://www.yuque.com/fengyong/game-develop-road)
-![](https://img.shields.io/badge/Cocos--Creator-2.1.3-blue)
+![](https://img.shields.io/badge/Cocos--Creator-2.2.1-blue)
+![](https://img.shields.io/badge/框架版本-1.0.0-blue)
+![](https://img.shields.io/badge/脚本语言-TypeScript-blue)
 
 ## 说明
 * 以个人实践为主，有些方案并非是最佳实践。我刚入门游戏开发，还在不断学习中。
@@ -10,64 +12,56 @@
 
 ## 使用方法
 * 拷贝整个项目作为基础使用。
-* 单文件直接使用，文件依赖参考文件头部import部分。针对3种特殊的依赖：
-    1. G，在 g-global.ts 中找到对应的方法，拷贝。
-    2. FMLog，使用 cc.log 代替，或者使用自定义的 log 方法。
-    3. FMVersion，使用 true/false 代替，或者直接删除，或者使用自定义的版本判定方法。
-* 思路参考，某些处理并非是最优解，但是提供了一个还算不错的思路可以参考。
+* 拷贝框架层所有文件并放入到现有项目中。推荐使用此方式，在框架层升级时可以直接替换。
+* 拷贝单个文件并放入到现有项目中。
+* 参考某些功能的实现方式，在现有项目中自己实现。
 
 ## 文件说明
-- [**`App`**] 游戏启动唯一主入口
-- [**`G`**] 通用方法
-- [**F系列脚本**] 框架层
-    - [**`FAnima`**] 动画
-    - [**`FColor`**] 颜色数据存储；绑定数据文件 data/color.ts
-    - [**`FHttp`**] 网络交互
-    - [**`FLocal`**] 本地存储；绑定数据文件 data/local.ts
-    - [**`FLog`**] 日志
-    - [**`FPanel`**] 界面
-    - [**`FSound`**] 声音；绑定数据文件 data/suond.ts
-    - [**`FText`**] 文字数据；绑定数据文件 data/text-*.ts
-    - [**`FVersion`**] 游戏版本
-- [**T系列脚本**] 工具层，一些独立的功能脚本
-    - [**`TChild`**] 子节点组合
-    - [**`TColor`**] 绑定颜色
-    - [**`TSize`**] 修改大小
-    - [**`TText`**] 绑定文字
-    - [**`TZIndex`**] 修改节点渲染顺序
-- [**data系列脚本**] 数据文件
-- [**C系列脚本**] controller 的缩写，表示控制器脚本
-- [**S系列脚本**] system 的缩写，表示系统脚本
-- [**Panel系列脚本**] 每个界面下挂载的默认脚本
+- **`App`** 游戏启动唯一主入口
+- 框架层
+    - **`FColor`** 颜色数据模块
+    - **`FHttp`** 网络模块（未完整实现）
+    - **`FLocal`** 本地存储模块
+    - **`FMeta`** 游戏数据表模块
+    - **`FNodeStateAnima`** 节点动画状态模块
+    - **`FPanel`** 界面模块
+    - **`FSound`** 声音模块
+    - **`FState`** 状态工具
+    - **`FText`** 文字模块（多语言）
+    - **`FTool`** 封装一些常用的方法
+    - **`Fversion`** 版本管理模块
+- 业务层
+    - **`T*`** 一些常用的工具脚本
+    - **`Data*`** 一些配置数据
+    - **`Meta*`** 数据表脚本
+    - **`Panel*`** 界面脚本
+    - **`C*`** Controller 脚本，一般需要继承 cc.Component，进行游戏逻辑的处理
+    - **`S*`** System 脚本，一般不继承 cc.Component，进行游戏数据的处理
 
-## 规范（仅针对 typescript）
+## 规范
 ### 命名规范（大驼峰，小驼峰，下划线，连接符）
-* 类名/模块名使用大驼峰，文件名与文件中主类（主模块）相同。
-* 常量使用下划线+大写字母
-* 变量/方法使用下划线+小写字母。（本项为了与引擎自带方法区分开，如果引擎使用下划线+小写字母命名，则本项使用小驼峰）
-* typescript 中的 enum/interface/type 使用大驼峰，并且利用前缀进行含义说明：
-    * Type* 表示类型
-    * Params* 表示参数（不论入参还是出参）
+* 类名、模块名使用大驼峰。文件名需要与文件中的主类、主模块名相同。
+* 常量名使用下划线+大写字母。
+* 变量名、方法名使用下划线+小写字母。本项为了与引擎自带方法区分开，如果引擎使用下划线+小写字母命名，则本项使用小驼峰。
+* enum、interface、type 使用大驼峰，并且利用前缀进行含义说明：
+    * Type* 表示类型。
+    * Params* 表示参数（不论入参还是出参）。
     * Data* 表示数据。
-* 最多使用 1 个前缀表示大类别，其余用后缀表示。
-    * anima_*，表示动画函数的前缀。
-    * *_btn，表示组件类型的后缀，类似的还有 _label/_sp 等。
-    * *_list，表示数据结构的后缀。（不要使用复数命名，使用单数对应的数据结构如 array/list/set/map 等）
-* 保证命名的统一性：如介词的使用（本项目中使用 to 和 by，其中 to 后面接输出值，by 后面接输入值），前缀，后缀，系统名等。
+* 保证命名的统一性
+    * 介词的使用，在本项目中，to 后接输出，by 后接输入。
+    * 前缀，后缀，系统名等。
 ### 代码规范
-* 代码次序为：import/cc._decorator，C（静态数据），enum/interface/type，main-class/main-namespace
-* 使用字符串枚举而不是数字枚举。不要使用 enum/cc.Enum，或者其他数字枚举，数字枚举再描述性上非常差。
-* 使用 export 而不是 export default。
-* 使用 module（export namespace）而不是 namespace。
-* 使用 module（export namespace）而不是 class 中的 static 方法。
-* 在 class 中，对于不需要外部调用的属性和方法，使用 private 而不是 public。
-* 在 module 中，不要轻易使用 export。
+* 代码次序为：import，cc._decorator，C（静态数据），enum，interface，type，main namespace，main class。
+* 使用「字符串字面量类型」或者「常量枚举类型」而不是「枚举类型」。因为前者在编译后会删除，后者则不会。
+* 使用「export」而不是「export default」。
+* 使用「export namespace」而不是「namespace」或者「类的静态方法」。
+* 在类中，优先使用「private」而不是「public」。
 * 在函数内部使用箭头函数而不是 function。外部函数定义可以使用 function。
 * 使用 forEach 或者其他高阶方法遍历而不是 for 循环。（for 循环的性能最高，在大数组遍历时可以使用）（高阶方法参考：https://www.yuque.com/fengyong/game-develop-road/gwv8xo ）
 * 避免在遍历时添加 break 和 return 逻辑，这样做会影响循环的语义性。
 * 避免对 object 类型的遍历，如果不可避免，则通过 Object.keys 方法转化为数组后遍历。
 * 使用双引号，反引号，而不是单引号。
 ### 架构规范
-* 极力避免对底层/中台进行修改，使用底层代码 + 数据配置文件的方案进行规避。（参考 FColor/FText/FSound）
+* 保证框架层的独立性，避免在框架层中直接写入数据。（参考 FColor 与 DataColor）。
 * 数据与显示分离，数据优于显示。（参考：https://www.yuque.com/fengyong/game-develop-road/toqqxe ）
 * 唯有设计上的统一性才能保证架构上的统一性，切记！
diff --git a/assets/resources/panel/PanelExample.prefab b/assets/resources/panel/PanelExample.prefab
@@ -25,7 +25,6 @@
       }
     ],
     "_active": true,
-    "_level": 1,
     "_components": [
       {
         "__id__": 8
@@ -52,17 +51,6 @@
       "x": 0.5,
       "y": 0.5
     },
-    "_eulerAngles": {
-      "__type__": "cc.Vec3",
-      "x": 0,
-      "y": 0,
-      "z": 0
-    },
-    "_skewX": 0,
-    "_skewY": 0,
-    "_is3DNode": false,
-    "groupIndex": 0,
-    "_id": "",
     "_trs": {
       "__type__": "TypedArray",
       "ctor": "Float64Array",
@@ -78,7 +66,19 @@
         1,
         1
       ]
-    }
+    },
+    "_eulerAngles": {
+      "__type__": "cc.Vec3",
+      "x": 0,
+      "y": 0,
+      "z": 0
+    },
+    "_skewX": 0,
+    "_skewY": 0,
+    "_is3DNode": false,
+    "_groupIndex": 0,
+    "groupIndex": 0,
+    "_id": ""
   },
   {
     "__type__": "cc.Node",
@@ -89,7 +89,6 @@
     },
     "_children": [],
     "_active": true,
-    "_level": 2,
     "_components": [
       {
         "__id__": 3
@@ -116,17 +115,6 @@
       "x": 0.5,
       "y": 0.5
     },
-    "_eulerAngles": {
-      "__type__": "cc.Vec3",
-      "x": 0,
-      "y": 0,
-      "z": 0
-    },
-    "_skewX": 0,
-    "_skewY": 0,
-    "_is3DNode": false,
-    "groupIndex": 0,
-    "_id": "",
     "_trs": {
       "__type__": "TypedArray",
       "ctor": "Float64Array",
@@ -142,7 +130,19 @@
         1,
         1
       ]
-    }
+    },
+    "_eulerAngles": {
+      "__type__": "cc.Vec3",
+      "x": 0,
+      "y": 0,
+      "z": 0
+    },
+    "_skewX": 0,
+    "_skewY": 0,
+    "_is3DNode": false,
+    "_groupIndex": 0,
+    "groupIndex": 0,
+    "_id": ""
   },
   {
     "__type__": "cc.Sprite",
@@ -196,7 +196,6 @@
     },
     "_children": [],
     "_active": true,
-    "_level": 2,
     "_components": [
       {
         "__id__": 6
@@ -223,17 +222,6 @@
       "x": 0.5,
       "y": 0.5
     },
-    "_eulerAngles": {
-      "__type__": "cc.Vec3",
-      "x": 0,
-      "y": 0,
-      "z": 0
-    },
-    "_skewX": 0,
-    "_skewY": 0,
-    "_is3DNode": false,
-    "groupIndex": 0,
-    "_id": "",
     "_trs": {
       "__type__": "TypedArray",
       "ctor": "Float64Array",
@@ -249,7 +237,19 @@
         1,
         1
       ]
-    }
+    },
+    "_eulerAngles": {
+      "__type__": "cc.Vec3",
+      "x": 0,
+      "y": 0,
+      "z": 0
+    },
+    "_skewX": 0,
+    "_skewY": 0,
+    "_is3DNode": false,
+    "_groupIndex": 0,
+    "groupIndex": 0,
+    "_id": ""
   },
   {
     "__type__": "cc.Label",