diff --git a/doc/game.md b/doc/game.md index 5bf44c1..d929b75 100644 --- a/doc/game.md +++ b/doc/game.md @@ -19,41 +19,30 @@ |-100|打包protobuf数据错误| |0|成功| |1| protobuf包体解析错误| -### 登录 LoginReq -| errorCode 返回值| 描述 | -| --- | --- | -|2|角色不存在| - -### 创建角色 CreateReq -| errorCode 返回值| 描述 | -| --- | --- | -|2|角色不存在| -|3|创建角色失败| - -### 阵容变换 ChangeTeamReq - -### 装备穿戴/脱下 HeroEquipReferReq -请求参数根据`hero_id`来判断穿戴或者脱下。 -- 穿戴: hero_id="" -- 脱下: hero_id != "" - -返回值: -| errorCode 返回值| 描述 | -| --- | --- | -|2|装备未获得| - -### 删除物品 RoleClearItemsReq -| errorCode 返回值| 描述 | -| --- | --- | -|2|删除失败| - -### 删除装备 EquipmentDelReq -| errorCode 返回值| 描述 | -| --- | --- | -|2|删除失败| -## 通知(服务器主动推送) -- 角色信息修改 RoleUpdatePropertyRsp -- 物品信息修改 RoleUpdateItemsRsp -- 添加装备 EquipmentAddRsp +### 文档 & 函数说明 +game文档使用godoc生成。查看格式是: +```go +1 func ChangeTeamRpc +2 func ChangeTeamRpc(role *models.RoleModel, msg components.IMessage) (int32, interface{}) +3 ChangeTeamRpc 阵容变换 +4 +5 +``` +- 第一行: 函数名字 +- 第二行: 函数声明 +- 第三行: 函数说明 +- 第五行: 返回错误码说明 + +请求参数是把函数最后的三位Rpc替换成Req， 名字是: `pb.ChangeTeamReq{}` + +### 接口查找 +通用地址 +```shell + 游戏服务ip:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index +``` +可以把游戏服务ip替换成192.168.0.206 +```shell +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index +``` diff --git a/doc/gm.md b/doc/gm.md index d2fb15e..a0d9ae6 100644 --- a/doc/gm.md +++ b/doc/gm.md @@ -5,10 +5,43 @@ 2. 提供外放接口,比如支付回调(为了安全也可以再开一个端口, 增加加密协议) ## 接口说明 -### 简单说明 + +### 文档 & 函数说明 +gm文档使用godoc生成。查看格式是: +```go +1 func (*GmAction) AddExp +2 func (gm *GmAction) AddExp(role *models.RoleModel, params GMParams) +3 AddExp 增加经验 +4 +5 exp: 增加经验数量 +``` +- 第一行: 函数名字 +- 第二行: 函数声明 +- 第三行: 函数说明 +- 第四行: 空格 +- 第五行: 参数1 +- 第...行: 参数... + + +### 接口查找 +通用地址 +```shell + 游戏服务ip:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index +``` +可以把游戏服务ip替换成192.168.0.206 +```shell +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index +``` + +用上述的增加经验例子，函数名字是AddExp。则接口地址是 +``` +http://192.168.0.206:8880/addexp?role_id=11exp=1000 +``` + +### 简单示例 地址示例, 增加经验接口: ```shell -http://192.168.0.206:8880/addexp +$ curl -i 'http://192.168.0.206:8880/addexp?role_id=150140287594270720&exp=111' ``` 返回值 ```shell @@ -30,65 +63,11 @@ http://192.168.0.206:8880/addexp |-102|角色id未填写| |-103|角色不存在| -下面接口中共同的请求参数和错误码省略。 需要保证参数先后顺序。 - -## 增加经验 [/addexp] -1. 请求方式: GET。 -3. 请求参数:(有参数就传) - -| 参数 | 类型 | 是否必须 | 备注 | -| --- | --- | --- | --- | -| exp | int | Y | 经验数量 | - -请求示例： -```shell -$ curl -i 'http://192.168.0.206:8880/addexp?role_id=150140287594270720&exp=111' -``` -返回结果: -```shell -{"code":0} -``` - - -## 添加装备 [/addequip] -1. 请求方式: GET。 -3. 请求参数:(有参数就传) - -| 参数 | 类型 | 是否必须 | 备注 | -| --- | --- | --- | --- | -| id | int | Y | 装备在配置表中的id | - -请求示例： -```shell -$ curl -i 'http://192.168.0.206:8880/addequip?role_id=1000002&id=0' -``` -返回结果: -```shell -{"code":0} -``` +下面接口中共同的请求参数和错误码省略。 -## 删除装备 [/delequip] -| 参数 | 类型 | 是否必须 | 备注 | -| --- | --- | --- | --- | -| id | string | Y | 服务器上的装备id | -请求示例： -```shell -$ curl -i 'http://192.168.0.206:8880/delequip?role_id=1000002&id=0' -``` -## 添加物品 [/additem] -| 参数 | 类型 | 是否必须 | 备注 | -| --- | --- | --- | --- | -| id | string | Y | 物品id | -| count | int | Y | 需要添加物品数量 | -## 删除物品 [/delitem] -| 参数 | 类型 | 是否必须 | 备注 | -| --- | --- | --- | --- | -| id | string | Y | 物品id | -| count | int | Y | 需要删除的物品数量 | +## 接口地址 +如果下面地址不通，则把ip替换成其他游戏服务的ip: -请求示例： -```shell -$ curl -i 'http://192.168.0.206:8880/delitem?role_id=1000002&id=1&count=1' -``` \ No newline at end of file +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index diff --git a/models.proto b/models.proto index ccf7926..659bdbe 100644 --- a/models.proto +++ b/models.proto @@ -63,4 +63,7 @@ message Role { map incres = 14; string items = 15;//物品 "id=count id2=count2" + uint32 clotheslimit = 16; + uint32 weaponslimit = 17; + uint32 otherlimit = 18; } -- libgit2 0.21.2