注释

game-server/app/services/refreshService.ts

@@ -4,6 +4,10 @@ import { STATUS } from '../consts/statusCode';
 import { resResult } from '../pubUtils/util';
 import { nowSeconds } from "../pubUtils/timeUtil";
 import { RoleModel } from '../db/Role';
+/**
+ * 刷新
+ * @param session 
+ */
 export async function refresh(session: FrontendOrBackendSession) {
     const roleId = session.get('roleId');
     const sid = session.get('sid');

shared/db/GuildRefine.ts

@@ -5,9 +5,9 @@ export class ScienceTree {
     @prop({ required: true })
     id: number;		
     @prop({ required: true })
-    endTime: number;
+    endTime: number;//科技树研发成功结束事件，时间戳，小于当前时间，说明开发完成
     @prop({ required: true, default: [], type: String, _id: false})
-    assistRoleIds: Array<string>;	
+    assistRoleIds: Array<string>;	//协助完成的玩家roleId
 }
 
 @index({ guildCode: 1 })
@@ -17,7 +17,7 @@ export default class GuildRefine extends BaseModel {
     guildCode: string;					
 
     @prop({ required: true, type: ScienceTree, default:[] })
-    scienceTrees: ScienceTree[];       
+    scienceTrees: ScienceTree[];     //科技树解锁情况  
 
     public static async createScienceTree(guildCode: string, scienceTrees: ScienceTree[], lean = true) {
         const result = await GuildRefineModel.findOneAndUpdate({ guildCode }, {$set: {scienceTrees}}, {new: true, upsert: true}).lean(lean);

shared/db/GuildTrain.ts

@@ -12,20 +12,20 @@ class TrainBox {
     @prop({ required: true })
     roleId: string;
     @prop({ required: true, type: Reward })
-    good: Reward;
+    good: Reward;//领取奖励
     @prop({ required: true })
-    index: number;
+    index: number;//领取位置
 }
 
 export class TrainInstance {
     @prop({ required: true })
     hid: number;
     @prop({ required: true })
-    progress: number;
+    progress: number;//进度
     @prop({ required: true })
-    endTime: number;
+    endTime: number;//挑战胜利后，宝箱领取有效时间
     @prop({ required: true, default: [], type: TrainBox, _id: false })
-    trainBoxs: TrainBox[];
+    trainBoxs: TrainBox[];//宝箱领取记录
 }
 
 class Rank {
@@ -49,7 +49,7 @@ export default class GuildTrain extends BaseModel {
     @prop({ required: true, default: [], type: Rank, _id: false })
     ranks: Rank[];
     @prop({ required: true, default: false})
-    locked: boolean;
+    locked: boolean; //逻辑删除
     
     public static async findGuildTrain(guildCode: string, select?: string, locked = false, lean = true) {
         const guildTrains: GuildTrainType[] = await GuildTrainModel.find({ guildCode, locked }).select(select).lean(lean);

shared/db/UserGuild.ts

@@ -13,17 +13,17 @@ class ActiveRecord {
 
 class WishGood {
     @prop({ required: true })
-    id: string;
+    id: string;//随机生成的唯一id
     @prop({ required: true })
-    type: number;
+    type: number;//1：表示装备池，2：武将池
     @prop({ required: true })
     goodId: number;
     @prop({ required: true })
-    count: number;
+    count: number; //许愿次数
     @prop({ required: true, default:0 })
-    receiveCnt: number;
+    receiveCnt: number; //收到次数
     @prop({ required: true, default:0 })
-    drawCnt: number;
+    drawCnt: number; //可以领取次数
     @prop({ required: true, type: String, default: [] })
     donateNames: string[];
 }

web-server/package.json

@@ -23,6 +23,7 @@
     "local": "cross-env EGG_SERVER_ENV=local npm run dev"
   },
   "dependencies": {
+    "chinese-random-name": "^1.0.0",
     "cross-env": "^7.0.3",
     "csprng": "^0.1.2",
     "egg": "^2.6.1",
@@ -30,6 +31,8 @@
     "egg-cors": "^2.2.3",
     "egg-scripts": "^2.6.0",
     "egg-view-nunjucks": "^2.2.0",
+    "mongoose-lean-getters": "^0.1.2",
+    "mongoose-lean-virtuals": "^0.7.6",
     "mongoose-transactions": "^1.1.4",
     "reflect-metadata": "^0.1.13",
     "underscore": "^1.12.0"