package gserver

Get desktop application:
View/edit binary Protocol Buffers messages

账号

• int64 _id = 1

• string name = 2

• string password = 3

注册账号

• string accountName = 1

• string password = 2

注册账号回复

• string accountName = 1

• int64 accountId = 2

活动基础配置

• int32 CfgId = 1

• string Name = 2

• string Detail = 3

• string Template = 4

  活动模板名

• int32 RefreshType = 5

  刷新机制(enum RefreshType)

• int32 CycleType = 6

  活动周期类型

• int32 TimeType = 7

  时间类型(enum TimeType)

• int32 BeginTime = 8

  开始时间(TimeType为TimeType_Timestamp时,格式是时间戳 TimeType为TimeType_Date时,格式是20240219)

• int32 EndTime = 9

  结束时间(TimeType为TimeType_Timestamp时,格式是时间戳 TimeType为TimeType_Date时,格式是20240219)

• repeated int32 ExchangeIds = 10

  兑换配置

• bool IsOff = 11

  是否关闭

• bool RemoveDataWhenEnd = 12

  活动结束时,是否删除活动数据

• int32 MinPlayerLevel = 14

  参与活动的最低玩家等级要求(0表示不限制)

• int32 MaxPlayerLevel = 15

  参与活动的最大玩家等级上限(0表示不限制)

• repeated int32 QuestIds = 16

  活动子任务id

• map<string, string> Properties = 17

  扩展属性

默认活动模板的基础数据

Used in: ActivitySync

• int32 LastUpdateTime = 1

  刷新时间戳

• int32 JoinTime = 4

  参加活动的时间(时间戳)

• map<string, int32> PropertiesInt32 = 5

  动态属性(int32)

删除一个活动

• int32 ActivityId = 1

  活动id

同步活动数据给客户端

• int32 ActivityId = 1

  活动id

• optional ActivityDefaultBaseData BaseData = 2

  活动数据

添加元素参数

Used in: ExchangeCfg, QuestCfg

• int32 CfgId = 1

  配置id

• int32 Num = 2

  数量

• int32 TimeType = 3

  时间类型(enum TimeType)

• int32 Timeout = 4

  结束时间(TimeType=Timestamp时,表示超时秒数 TimeType=Date时,表示日期,如20240219)

• int32 Source = 5

  来源(一般用于数据分析)

• map<string, string> Properties = 6

  扩展属性

背包模块数据

Used in: PlayerData

• map<int32, int32> CountItem = 1

• map<int64, bytes> UniqueItem = 2

• map<int64, bytes> Equip = 3

背包数据同步给客户端

• map<int32, int32> CountItem = 1

  可叠加的普通物品

• map<int64, UniqueCountItem> UniqueItem = 2

  不可叠加的普通物品

• map<int64, Equip> Equip = 3

  装备

玩家基础信息

Used in: BaseInfoSync, PlayerData

• int32 gender = 1

  性别

• int32 level = 2

  等级

• int32 exp = 3

  经验值

• int32 totalPay = 4

  累充总额

• int32 lastUpdateDate = 5

  上次刷新日期,格式:yyyymmdd

• int64 lastLoginTimestamp = 6

  最近一次登录时间戳

• int64 lastLogoutTimestamp = 7

  最近一次退出时间戳

• int32 totalOnlineSeconds = 8

  总在线时长(秒)

• optional BaseInfo data = 1

CfgId + Arg

Used in: QuestCfg

• int32 CfgId = 1

  配置id

• int32 Arg = 2

  单个参数值

CfgId + Args + Options

Used in: ExchangeCfg, QuestCfg

• int32 CfgId = 1

  配置id

• repeated int32 Args = 2

  参数值数组

• repeated int32 Options = 3

  可选参数数组

CfgId + Args

• int32 CfgId = 1

  配置id

• repeated int32 Args = 2

  参数值数组

客户端掉线

• uint32 clientConnId = 1

• Color_None = 0

• Color_Red = 1

• Color_Green = 2

• Color_Blue = 3

• Color_Yellow = 4

• Color_Gray = 5

条件配置(ConditionTemplateCfg + Values + 可选Options)

Used in: ExchangeCfg, QuestCfg

• int32 Type = 1

  条件类型(enum ConditionType)

• string Key = 2

  关键字,如ConditionType_PlayerPropertyCompare对应的属性名

• string Op = 3

  操作符 = > >= < <= != [] ![]

• repeated int32 Values = 4

  比较的值(可配多个)

• repeated int32 Options = 5

  可选参数(可配多个)

• map<string, string> Properties = 6

  扩展属性

• bool ClientCheck = 7

  客户端是否可以直接判断条件,比如玩家的等级

条件模板配置

• int32 CfgId = 4

  配置id

• int32 Type = 1

  条件类型(enum ConditionType)

• string Key = 2

  关键字,如ConditionType_PlayerPropertyCompare对应的属性名

• string Op = 3

  操作符 = > >= < <= != [] ![]

• map<string, string> Properties = 5

  扩展属性

• bool ClientCheck = 6

  客户端是否可以直接判断条件,比如玩家的等级

条件类型

• ConditionType_None = 0

  解决"The first enum value must be zero in proto3."的报错

• ConditionType_PlayerPropertyCompare = 1

  玩家属性值比较

• ConditionType_ActivityPropertyCompare = 2

  活动属性值比较

容器类型

Used in: ElemOp

• ContainerType_None = 0

• ContainerType_CountItem = 1

  可叠加的普通物品

• ContainerType_UniqueItem = 2

  不可叠加的普通物品(如带限时属性的普通物品)

• ContainerType_Equip = 3

  装备

可数的普通物品(可叠加的)

• int32 cfgId = 1

  物品配置id

• int32 count = 2

  物品数量

创建角色

• int64 accountId = 1

• string loginSession = 2

  账号验证成功后的缓存session

• int32 regionId = 3

  区服id

• string name = 4

  玩家名

• int32 gender = 5

  性别

创建角色

• int64 accountId = 1

• int32 regionId = 2

  区服id

• string name = 3

  玩家名

删除元素参数

• int64 UniqueId = 1

  唯一id(删除指定的不可叠加的元素才需要)

• int32 CfgId = 2

  配置id

• int32 Num = 3

  数量

• int32 Source = 4

  来源(一般用于数据分析)

• map<string, string> Properties = 5

  扩展属性

容器更新 整合不同的容器,不同的操作类型(增加,更新,删除),都统一在一个消息里面

• repeated ElemOp ElemOps = 1

  容器数据变化,增加,更新,删除

元素数量

• int32 CfgId = 1

  配置id

• int32 Num = 2

  数量

容器内元素数据变化

Used in: ElemContainerUpdate

• ContainerType ContainerType = 1

• ElemOpType OpType = 2

• optional google.protobuf.Any elemData = 3

  元素数据

容器内元素数据变化类型

Used in: ElemOp

• ElemOpType_None = 0

• ElemOpType_Add = 1

  新加

• ElemOpType_Update = 2

  更新属性(不可叠加的元素,如装备)

• ElemOpType_Delete = 3

  删除

装备(不可叠加的)

Used in: BagsSync

• int64 uniqueId = 1

  唯一id

• int32 cfgId = 2

  物品配置id

• int32 timeout = 3

  超时时间戳(秒)

• ErrorCode_OK = 0

• ErrorCode_NotReg = 11

  未注册

• ErrorCode_PasswordError = 12

  密码错误

• ErrorCode_DbErr = 13

  数据库错误

• ErrorCode_NameDuplicate = 14

  重名

• ErrorCode_HasLogin = 15

• ErrorCode_SessionError = 16

• ErrorCode_NoPlayer = 17

• ErrorCode_TryLater = 18

通用的错误返回消息

• int32 command = 1

  消息号

• int32 resultId = 2

  错误信息id

• string resultStr = 3

  错误信息内容

活动属性值更新(int32)

• int32 ActivityId = 1

• string Property = 2

  属性名

• int32 Delta = 3

  变化量

• int32 Current = 4

  当前值

战斗事件

• int64 PlayerId = 1

• bool IsPvp = 2

• bool IsWin = 3

• int32 RoomType = 4

  房间类型(1:新手模式(PVE) 2:普通匹配 3:天梯匹配 4:机器人对抗(PVE) 5:自定义房间)

• int32 RoomLevel = 5

  房间等级

• int32 Score = 6

  战斗得分

玩家属性值更新(int32)

• int64 PlayerId = 1

• string Property = 2

  属性名

• int32 Delta = 3

  变化量

• int32 Current = 4

  当前值

兑换分类

• ExchangeCategory_None = 0

• ExchangeCategory_Shop = 1

  商店

兑换配置

• int32 CfgId = 1

• repeated ConditionCfg Conditions = 2

  兑换条件

• repeated ItemNum Consumes = 3

  需要消耗的物品

• repeated AddElemArg Rewards = 4

  获得物品

• int32 CountLimit = 5

  兑换次数限制(0表示无次数限制)

• int32 RefreshType = 6

  刷新机制(enum RefreshType)

• int32 Category = 7

  兑换分类(enum ExchangeCategory)

• map<string, string> Properties = 8

  扩展属性

• string Detail = 9

• string Icon = 10

  图标(客户端使用)

• repeated CfgArgOptions ConditionTemplates = 21

  关联的配置模板id和参数,简化配置表用,业务代码不要调用

兑换记录

Used in: ExchangeRes, ExchangeSync, ExchangeUpdate

• int32 CfgId = 1

• int32 Count = 2

• int32 Timestamp = 3

  最近一次兑换的时间戳(秒)

兑换数据删除

• repeated int32 CfgIds = 1

  兑换配置id

兑换请求req

• repeated IdCount IdCounts = 1

  支持批量兑换

兑换请求res

• repeated IdCount IdCounts = 1

  兑换请求数据

• repeated ExchangeRecord Records = 2

  当前兑换记录

同步兑换数据给客户端

• map<int32, ExchangeRecord> Records = 1

兑换数据更新

• repeated ExchangeRecord Records = 1

  兑换数据

完成任务

• repeated int32 questCfgIds = 1

  任务id

完成任务的返回结果

• repeated int32 questCfgIds = 1

  任务id

• repeated FinishedQuestData finishedQuestDatas = 2

  完成任务的数据

已完成的任务

Used in: FinishQuestRes, QuestSync

• int32 timestamp = 1

  完成时间戳(秒)

游戏服务器信息

Used in: LoginRes

• int32 serverId = 1

  服务器编号

• string clientListenAddr = 2

  游戏服监听客户端地址

网关转发客户端消息到其他服务器,发生错误

• int64 playerId = 1

• int32 command = 2

  消息号

• int32 resultId = 3

  错误信息id

• string resultStr = 4

  错误信息内容

GlobalEntity在mongo中的保存格式 用于一次性把数据加载进来

• string key = 1

• optional ProcessStatInfo processStatInfo = 2

创建公会请求

• string name = 1

  名称

• string intro = 2

  介绍

创建公会请求返回结果 @Player

• string error = 1

• int64 id = 2

  公会id

• string name = 3

  名称

公会数据

Used in: GuildDataViewRes

• int64 id = 1

  公会唯一id

• optional GuildInfo baseInfo = 2

• map<int64, GuildMemberData> members = 3

  公会成员

• map<int64, GuildJoinRequest> joinRequests = 4

  申请加入公会的请求信息

查看自己公会的数据

(message has no fields)

查看公会数据返回结果 @Player

• optional GuildData guildData = 1

公会信息

Used in: GuildData, GuildListRes, GuildLoadData

• int64 id = 1

  公会id

• string name = 2

  名称

• string intro = 3

  介绍

• int32 memberCount = 4

  成员数

管理员同意请求者加入公会

• int64 joinPlayerId = 1

  申请加入公会的玩家id

• bool isAgree = 2

  是否同意加入

同意加入公会返回结果 @Player

• string error = 1

• int64 guildId = 2

• int64 managerPlayerId = 3

  管理员id

• int64 joinPlayerId = 4

  申请加入公会的玩家id

• bool isAgree = 5

  是否同意加入

加入公会请求

• int64 id = 1

  公会id

自己的入会申请的操作结果

• string error = 1

• int64 guildId = 2

• int64 managerPlayerId = 3

  管理员id

• int64 joinPlayerId = 4

  申请加入公会的玩家id

• bool isAgree = 5

  是否同意加入

提示有人申请加入本公会

• int64 playerId = 1

  玩家id

• string playerName = 2

  玩家名

申请加入公会的请求信息

Used in: GuildData

• int64 playerId = 1

  申请加入公会的玩家id

• string playerName = 2

• int32 timestampSec = 3

  时间戳(秒)

加入公会请求返回结果 @Player

• string error = 1

• int64 id = 2

  公会id

查看公会列表

• int32 pageIndex = 1

  分页索引

查看公会列表返回结果 @Player

• int32 pageIndex = 1

  分页索引

• int32 pageCount = 2

  总页数

• repeated GuildInfo guildInfos = 3

  公会列表

公会在mongo中的保存格式 用于一次性把公会数据加载进来

• int64 id = 1

  公会唯一id

• optional GuildInfo baseInfo = 2

• map<int64, GuildMemberData> members = 3

  公会成员(明文)

• map<int64, bytes> joinRequests = 4

  申请加入公会的请求信息(proto序列化)

公会成员数据

Used in: GuildData, GuildLoadData

• int64 id = 1

  玩家id

• string name = 2

  玩家名称

• int32 position = 3

  职位

• Member = 0

  普通成员

• Manager = 1

  管理员

• Leader = 2

  会长

路由转发玩家的公会请求消息 server -> otherserver -> guild

• int64 fromPlayerId = 1

  玩家id

• int64 fromGuildId = 2

  玩家公会id

• int32 fromServerId = 3

  玩家当前所在服务器id

• string fromPlayerName = 4

  玩家名

• int32 packetCommand = 5

  消息号

• optional google.protobuf.Any packetData = 6

  消息内容

• optional PlayerGuildData data = 1

心跳包请求

• int64 timestamp = 1

  请求方的时间戳(毫秒)

心跳包回复

• int64 requestTimestamp = 1

  请求方的时间戳(毫秒)

• int64 responseTimestamp = 2

  回复方的时间戳(毫秒)

Id和数量

Used in: ExchangeReq, ExchangeRes

• int32 Id = 1

• int32 Count = 2

  数量

物品分类

• ItemCategory_None = 0

物品配置

• int32 CfgId = 1

• string Name = 2

• string Detail = 3

• int32 ItemType = 4

  物品类型(enum ItemType)

• int32 SubType = 5

  物品子类(enum ItemSubType)

• int32 Category = 6

  物品分类(enum ItemCategory)

• repeated int32 Args = 7

  参数列表(比如ItemSubType=ItemSubType_Exp是,表示加经验的数值)

• int32 TimeType = 8

  限时道具的时间类型(enum TimeType)

• int32 Timeout = 9

  限时道具的时限

• int32 ViewType = 10

  物品显示类型(enum ItemViewType)

• map<string, string> Properties = 11

  扩展属性

• string Icon = 12

  物品图标(客户端使用)

特殊的物品Id

• ItemId_None = 0

• ItemId_Coin = 1

  金币

物品数量

Used in: ExchangeCfg, QuestCfg

• int32 CfgId = 1

  物品配置id

• int32 Num = 2

  物品数量

物品子类

• ItemSubType_None = 0

• ItemSubType_Gold = 1

  金币

• ItemSubType_Exp = 2

  经验丹

• ItemSubType_Quest = 3

  任务物品

物品类型

• ItemType_None = 0

  普通物品

• ItemType_Equip = 1

  装备

使用道具请求

• int32 cfgId = 1

  物品配置id

• int64 uniqueId = 2

  唯一id

使用道具结果

• int32 cfgId = 1

  物品配置id

• int64 uniqueId = 2

  唯一id

物品显示类型

• ItemViewType_None = 0

• ItemViewType_Hide = 1

  隐藏,不显示在背包中,不占背包格子

踢玩家下线req

• int64 accountId = 1

  账号id

• int64 playerId = 2

  玩家id

踢玩家下线res

• string error = 1

• int64 accountId = 2

  账号id

• int64 playerId = 3

  玩家id

升级经验

• int32 Level = 1

  等级

• int32 NeedExp = 2

  升到该等级需要的经验值

账号登录请求

• string accountName = 1

• string password = 2

账号登录回复

• string accountName = 1

• int64 accountId = 2

• string loginSession = 3

  账号验证成功后的缓存session

• optional GameServerInfo gameServer = 4

  游戏服信息

待处理消息

• int64 messageId = 1

  唯一id

• int32 packetCommand = 2

  消息号

• optional google.protobuf.Any packetData = 3

  消息内容

• int32 timestamp = 4

  时间戳

玩家在mongo中的保存格式 用于一次性把玩家数据加载进来

• int64 _id = 1

  玩家id

• string Name = 2

  玩家名

• int64 AccountId = 3

  账号id

• int32 RegionId = 4

  区服id

• optional BaseInfo BaseInfo = 5

• optional BagSaveData Bags = 7

• optional QuestSaveData Quest = 8

• optional PlayerGuildData Guild = 9

• map<int64, bytes> PendingMessages = 10

  map<int64,*PendingMessage>

• map<int32, bytes> Activities = 11

  map<int32,*ActivityDefaultBaseData>

• map<int32, bytes> Exchange = 12

  map<int32,*ExchangeRecord>

玩家进游戏服成功,非客户端消息

• bool isReconnect = 1

玩家登录游戏服

• int64 accountId = 1

• string loginSession = 2

  账号验证成功后的缓存session

• int32 regionId = 3

  区服id

玩家登录游戏服回复 @Player

• int64 accountId = 1

• int64 playerId = 2

• int32 regionId = 3

  区服id

• string playerName = 4

玩家身上的公会数据

Used in: GuildSync, PlayerData

• int64 guildId = 1

  公会id

进程统计信息

Used in: GlobalEntityData

• int64 lastStartupTimestamp = 1

  最近一次进程启动时间戳

• int64 lastShutdownTimestamp = 2

  最近一次进程关闭时间戳

• int32 lastUpdateDate = 3

  上次刷新日期,格式:yyyymmdd

进度配置(ProgressTemplateCfg + Total)

Used in: QuestCfg

• int32 Type = 1

  进度类型(enum ProgressType)

• int32 Total = 2

  总进度要求

• bool NeedInit = 3

  接任务时,是否初始化一下当前进度

• string Event = 4

  关联的事件名

• string ProgressField = 5

  以事件字段值作为进度值,为空表示进度值是1

• map<string, ValueCompareCfg> IntEventFields = 6

  数值类型的事件字段值(支持复杂的比较操作符)

• map<string, string> StringEventFields = 7

  事件字段值(字符串形式)

• map<string, string> Properties = 8

  扩展属性

进度模板配置

• int32 CfgId = 1

  配置id

• int32 Type = 2

  进度类型(enum ProgressType)

• bool NeedInit = 3

  接任务时,是否初始化一下当前进度

• string Event = 4

  关联的事件名

• string ProgressField = 5

  以事件字段值作为进度值,为空表示进度值是1

• map<string, ValueCompareCfg> IntEventFields = 6

  数值类型的事件字段值(支持复杂的比较操作符)

• map<string, string> StringEventFields = 7

  事件字段值(字符串形式)

• map<string, string> Properties = 8

  扩展属性

进度类型

• ProgressType_None = 0

  解决"The first enum value must be zero in proto3."的报错

• ProgressType_Event = 1

  通用事件匹配,如果ProgressCfg配置了EventField,则使用触发事件的该字段值作为进度值,如果没配置EventField,则默认进度值为1

任务分类 (NOTE:根据项目实际需求,自行调整)

• QuestCategory_None = 0

任务配置

• int32 CfgId = 1

• string Name = 2

• int32 QuestType = 3

  任务类型(enum QuestType)

• int32 RefreshType = 4

  刷新机制(enum RefreshType)

• int32 Category = 5

  任务分类(enum QuestCategory)

• repeated AddElemArg Rewards = 6

  任务奖励

• int32 PreQuest = 7

  前置任务

• repeated int32 NextQuests = 8

  完成该任务后,自动接后续的任务(任务链)

• repeated ConditionCfg Conditions = 9

  任务条件

• optional ProgressCfg Progress = 10

  任务进度(收集类物品,此字段可能为空)

• map<string, string> Properties = 11

  扩展属性

• string Detail = 12

  任务描述

• int32 PlayerLevel = 13

  玩家等级限制(0表示不限制)

• repeated ItemNum Collects = 14

  需要收集的物品(一般是任务物品)

• repeated CfgArgOptions ConditionTemplates = 21

  关联的配置模板id和参数,简化配置表用,业务代码不要调用

• optional CfgArg ProgressTemplate = 22

  关联的配置模板id和参数,简化配置表用,业务代码不要调用

任务数据

Used in: QuestSync, QuestUpdate

• int32 cfgId = 1

  配置id

• int32 progress = 2

  进度

• int32 activityId = 3

  活动id,只有活动子任务才会有值

删除一个任务

• int32 questCfgId = 1

  任务id

任务模块数据

Used in: PlayerData

• map<int32, bytes> finished = 1

  已完成的任务

• map<int32, bytes> quests = 2

  进行中的任务

同步任务数据给客户端

• map<int32, FinishedQuestData> finished = 1

  已完成的任务

• map<int32, QuestData> quests = 2

  进行中的任务

任务类型 (NOTE:根据项目实际需求,自行调整)

• QuestType_None = 0

• QuestType_SubQuest = 1

  其他系统的子任务(如活动的子任务)

• QuestType_Achievement = 2

  成就

任务数据更新

• int32 questCfgId = 1

  任务id

• optional QuestData data = 2

刷新方式

• RefreshType_None = 0

  解决"The first enum value must be zero in proto3."的报错

• RefreshType_Day = 1

  每日重置

路由转发给玩家的消息 server -> otherserver -> player

• string error = 1

  错误码

• int64 toPlayerId = 2

  玩家id

• int32 packetCommand = 3

  消息号

• bool directSendClient = 4

  是否直接转发给客户端

• int64 pendingMessageId = 5

  待处理消息id

• optional google.protobuf.Any packetData = 6

  转发的消息

服务器连接上其他服务器时,发的初始化信息

• int32 serverId = 1

  服务器id

• string serverType = 2

  服务器类型

服务器信息

• int32 serverId = 1

  服务器id

• string serverType = 2

  服务器类型

• string serverListenAddr = 3

  监听服务器地址

• string clientListenAddr = 4

  监听客户端地址

• string gateListenAddr = 5

  监听网关地址

• int64 lastActiveTime = 6

  最近上传信息的时间戳(毫秒)

• int32 ping = 7

  ping值(毫秒)

商店配置

• int32 CfgId = 1

  商店id

• string Name = 2

  商店名

• repeated int32 ExchangeIds = 3

  商店的每1个格子就是1个兑换礼包

• map<string, string> Properties = 8

  扩展属性

• int64 timestamp = 1

• int64 timestamp = 1

测试命令

• string cmd = 1

时间类型

• TimeType_None = 0

• TimeType_Timestamp = 1

  时间戳

• TimeType_Date = 2

  日期(格式:20240219)

Type + Value

• int32 Type = 1

  类型

• int32 Value = 2

  值

不可叠加的普通物品(比如普通物品加了限时属性,就是不可叠加的了)

Used in: BagsSync

• int64 uniqueId = 1

  唯一id

• int32 cfgId = 2

  物品配置id

• int32 timeout = 3

  超时时间戳(秒)

int64封装成message,用于序列化成google.protobuf.Any

• int64 Id = 1

数值比较配置

Used in: ProgressCfg, ProgressTemplateCfg

• string Op = 1

  操作符 = > >= < <= != [] ![]

• repeated int32 Values = 2

  比较的值(可配多个)