增加接口说明

tools/messages.md

@@ -0,0 +1,233 @@
+### 接口说明
+        {
+            //获取网络配置，和以前一样
+            "id": 1,
+            "name": "getAllConfigInfo",
+            "method": "POST",
+            "send": {
+                "versionCode": "string"
+            },
+            "response": {
+                "data": "jsonstr"
+            }
+        },
+        {
+            //获取玩家游戏数据
+            "id": 2,
+            "name": "player",
+            "method": "GET",
+            "send": null,
+            "response": {
+                "data": "PlayerProp"
+            }
+        },
+        {
+            //预留，暂未使用,获取所有武将信息
+            "id": 3,
+            "name": "generalpack",
+            "method": "GET",
+            "send": null,
+            "response": {
+                "data": ["GeneralProp"]     //所有武将信息
+            }
+        },
+        {
+            //预留，暂未使用，更新武将属性
+            "id": 4,
+            "name": "updateGeneralProp",
+            "method": "GET",
+            "send": {
+                type:number,//武将属性类型
+                value:number//武将属性值
+            },
+            "response": {
+                type:number,//武将属性类型
+                value:number//武将属性值
+            }
+        },
+        {
+            //武将升星
+            "id": 5,
+            "name": "updateGeneralXS",
+            "method": "POST",
+            "send": {
+                gid:number  //武将id
+            }
+            "response": {
+                "data": "jsonstr" //网络配置
+            }
+        },
+        {
+            //更新玩家属性
+            "id": 6,
+            "name": "updatePlayerProp",
+            "method": "POST",
+            "send": {
+                proptype:number,    //属性类型
+                propvalue:number,   //属性值
+                add:number      //0当前值  1增加值
+            },
+            "response": {
+                "data": {
+                    proptype:number,    //属性类型
+                    propvalue:number,   //当前值
+                    addvalue:number     //增加值
+                },
+            }
+        },
+        {
+            //更换布阵信息
+            "id": 7,
+            "name": "changeEmbattle",
+            "method": "POST",
+            "send": [{  //当前阵上的所有武将信息
+                gid:number, //武将id
+                pos:number  //武将位置 0-4
+            }],
+            "response":  [{  //当前阵上的所有武将信息
+                gid:number, //武将id
+                pos:number  //武将位置 0-4
+            }],
+        },
+        {
+            //武将合成
+            "id": 8,
+            "name": "composeGeneral",
+            "method": "POST",
+            "data": {
+                gid:number  //武将id
+            }
+            "response": {
+                "data": GeneralProp
+            }
+        },
+        {
+            //过关校验
+            "id": 9,
+            "name": "updateMission",
+            "method": "POST",
+            "data": {
+                mid:number,//关卡id
+                max:[gid],//最大战力武将id
+                last:[gid]//通关时武将id
+            },
+            "response": {
+                "data": {
+                    rewards:string  //过关奖励，只有boss关有，额外根据ecpm增加奖励  "1:100;2:200,3:300;4:114016;5:123008:66"
+                }
+            }
+        },
+        {
+            //武将升级
+            "id": 10,
+            "name": "generalExpUp",
+            "method": "POST",
+            "data": "null",
+            "response": {
+                "data": {
+                    gid: number;    //武将id
+                    exp: number;    //当前武将经验
+                    addExp:number;  //增加的经验
+                    lv: number;     //当前武将等级
+                    food:number;    //当前剩余粮草
+                }
+            }
+        }
+    ],
+
+
+### 玩家属性：
+        "PlayerProp": {
+
+            /** 唯一ID */
+            "uid": "string";
+
+            /** 粮草 */
+            "food": "number";
+
+            /** 元宝 */
+            "yb": "number";
+
+            /** 红包币 */
+            "redbag": "number";
+
+            /** 兵营等级 */
+            "barrack": "number";
+
+            /** 当前粮草上限 */
+            "foodmax":"number";
+
+            /** 当前粮草恢复速度 */
+            foodrecover:number;
+
+            /** 当前到达的最大关卡 */
+            mission_arrive: number;
+
+            /** 当前通过的最大关卡，仅用于判定是否结算奖励，可能不需要 */
+            mission_passed: number;
+
+            /** 
+            * 武将信息 将GeneralMsg转换成字符串，多个武将中间用英文‘,’隔开
+            * 例   id,status,pos,exp,lv,star,fragment:143013,1,0,0,1,1,10
+            */
+            generalpack: string;
+        },
+
+#### 武将属性
+        "GeneralProp":{
+
+            /** 武将id */
+            id: number;
+
+            /** 武将状态 是否激活 GENERALSTATUS */
+            status: number;
+
+            /** 位置 0-4表示在阵上 -1表示不在阵上 */
+            pos: number;
+
+            /** 当前等级的经验 */
+            exp: number
+
+            /** 当前等级 */
+            lv: number;
+
+            /** 当前星级 */
+            star: number;
+
+            /** 当前碎片数 */
+            fragment: number;
+        }
+
+
+### 属性值
+//玩家属性
+export enum PLAYERPROP {
+    FOOD = 1,//当前拥有的粮草
+    YB = 2,
+    REDBAG = 3,
+    FOODRECOVER = 4,//当前粮草获取速度
+    FOODMAX = 5,//当前粮草上限
+    FOODCONSUME = 6,//当前升级武将单次点击消耗的粮草
+    PRESTIGE = 7,//威望
+
+    BARRACK = 10,//兵营等级
+
+    MISSION_ARRIVE = 20,//当前到达的最大关卡
+    MISSION_PASSED = 21,//当前通过的最大关卡
+}
+
+//道具类型
+export enum ITEMTYPE {
+    FOOD = 1,//
+    YB = 2,
+    REDBAG = 3,
+    PRESTIGE = 4,
+    GENERAL = 10,
+    GENERAL_FRAGMENT = 11,
+}
+
+//武将状态
+export enum GENERALSTATUS {
+    NONE = 0,//未拥有（只有碎片/未合成）
+    GET = 1,//已拥有
+}