From 5ba6f1b8efadf1cdba903fc1db75d65bdec22926 Mon Sep 17 00:00:00 2001 From: 1 <1@72wo.cn> Date: Tue, 26 Aug 2025 23:22:10 +0000 Subject: [PATCH] =?UTF-8?q?refactor(docs):=20=E6=B8=85=E7=90=86=E4=BB=A3?= =?UTF-8?q?=E7=A0=81=E6=B3=A8=E9=87=8A=E4=B8=AD=E7=9A=84=E5=86=97=E4=BD=99?= =?UTF-8?q?Java=E5=AF=B9=E5=BA=94=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- logic/controller/map.go | 2 +- logic/service/fight/fight.go | 24 ++++++++-------- .../fight/info/NoteReadyToFightInfo.go | 28 +++++++++---------- logic/service/login/create_player.go | 4 +-- logic/service/maps/mapin.go | 2 +- logic/service/room/FitmentShowInfo.go | 4 +-- logic/service/space/walk.go | 4 +-- logic/service/systemtime/System.go | 2 +- modules/blazing/model/TeamInfo.go | 4 +-- modules/blazing/model/pet.go | 6 ++-- modules/blazing/model/player.go | 4 +-- 11 files changed, 42 insertions(+), 42 deletions(-) diff --git a/logic/controller/map.go b/logic/controller/map.go index 425ecbcb3..d4866aa8f 100644 --- a/logic/controller/map.go +++ b/logic/controller/map.go @@ -131,7 +131,7 @@ func genMonster(id uint32) maps.OgreInfo { return t1 } -// 计算整数的二进制1的个数（对应Java的Integer.bitCount） +// 计算整数的二进制1的个数（Integer.bitCount） func bitsCount(n int) int { count := 0 for n > 0 { diff --git a/logic/service/fight/fight.go b/logic/service/fight/fight.go index 7387a6dfe..c8193ce29 100644 --- a/logic/service/fight/fight.go +++ b/logic/service/fight/fight.go @@ -8,7 +8,7 @@ import ( type FightNpcMonsterInboundInfo struct { Head handler.TomeeHeader `cmd:"2408" struc:"[0]pad"` // Number 地图刷新怪物结构体对应的序号（1-9的位置序号） - // 对应Java的@UInt long类型，使用uint32保持无符号特性 + // @UInt long类型，使用uint32保持无符号特性 Number uint32 `fieldDesc:"地图刷新怪物结构体对应的序号 1 - 9 的位置序号" ` } @@ -21,7 +21,7 @@ type ReadyToFightInboundInfo struct { } type FightStartOutboundInfo struct { - // 对应Java的@UInt long类型 + // @UInt long类型 IsCanAuto uint32 `fieldDesc:"是否自动 默认给0 怀疑是自动战斗器使用的" ` // 当前战斗精灵信息1（前端通过userid判断是否为我方） @@ -31,34 +31,34 @@ type FightStartOutboundInfo struct { Info2 FightPetInfo `fieldDesc:"当前战斗精灵的信息 可能不准.看前端代码是以userid来判断哪个结构体是我方的" serialize:"struct"` } -// FightPetInfo 战斗精灵信息结构体，对应Java的FightPetInfo类 +// FightPetInfo 战斗精灵信息结构体，FightPetInfo类 type FightPetInfo struct { - // 用户ID（野怪为0），对应Java的@UInt long + // 用户ID（野怪为0），@UInt long UserID uint32 `fieldDesc:"用户ID 野怪为0" ` - // 当前对战精灵ID，对应Java的@UInt long + // 当前对战精灵ID，@UInt long PetID uint32 `fieldDesc:"当前对战精灵ID" ` - // 空的16字节byte，对应Java的固定长度字符串 + // 空的16字节byte，固定长度字符串 // 使用[16]byte匹配固定长度16字节的要求 PetName [16]byte `fieldDesc:"空的16字节byte" serialize:"fixedLength=16,type=byteArray"` - // 精灵的捕获时间，对应Java的@UInt long + // 精灵的捕获时间，@UInt long CatchTime uint32 `fieldDesc:"精灵的捕获时间" ` - // 当前HP，对应Java的@UInt long + // 当前HP，@UInt long Hp uint32 `fieldDesc:"当前HP" ` - // 最大HP，对应Java的@UInt long + // 最大HP，@UInt long MaxHp uint32 `fieldDesc:"最大HP" ` - // 当前等级，对应Java的@UInt long + // 当前等级，@UInt long Level uint32 `fieldDesc:"当前等级" ` - // 精灵是否能捕捉（1为能捕捉，0为不能捕捉），对应Java的@UInt long + // 精灵是否能捕捉（1为能捕捉，0为不能捕捉），@UInt long Catchable uint32 `fieldDesc:"精灵是否能捕捉. 1为能捕捉 0为不能捕捉" ` // 战斗属性等级数组（6个单字节） - // 对应Java的byte[]，固定长度6，存储buff等级、攻击、速度等属性 + // byte[]，固定长度6，存储buff等级、攻击、速度等属性 BattleLV [6]byte `fieldDesc:"这里实际上应该是6个单字节byte, 内容为buff等级 攻击 速度 特攻 防御 特防 命中等.但具体顺序未知可能需要测试. 具体数值为1-6等级" serialize:"fixedLength=6,type=byteArray"` } diff --git a/logic/service/fight/info/NoteReadyToFightInfo.go b/logic/service/fight/info/NoteReadyToFightInfo.go index d71b8c336..7511b2c2f 100644 --- a/logic/service/fight/info/NoteReadyToFightInfo.go +++ b/logic/service/fight/info/NoteReadyToFightInfo.go @@ -5,7 +5,7 @@ import ( ) type FightUserInfo struct { - // 用户ID（野怪为0），对应Java的@UInt long + // 用户ID（野怪为0），@UInt long UserID uint32 `fieldDesc:"userID 如果为野怪则为0" ` // 玩家名称（野怪为UTF-8的'-'，固定16字节） @@ -13,19 +13,19 @@ type FightUserInfo struct { Nickname [16]byte ` ` } -// NoteReadyToFightInfo 战斗准备就绪消息结构体，对应Java的NoteReadyToFightInfo +// NoteReadyToFightInfo 战斗准备就绪消息结构体，NoteReadyToFightInfo type NoteReadyToFightInfo struct { //战斗发起者ID OwnerID uint32 `struc:"skip"` // 战斗类型ID（与野怪战斗为3，与人战斗为1，前端似乎未使用） - // 对应Java的@UInt long + // @UInt long FightId uint32 `fieldDesc:"战斗类型ID 但前端好像没有用到 与野怪战斗为3，与人战斗似乎是1" ` // 我方信息 OurInfo FightUserInfo `fieldDesc:"我方信息" serialize:"struct"` OurPetListLen uint32 `struc:"sizeof=OurPetList"` // 我方携带精灵的信息 - // 对应Java的ArrayList，使用切片模拟动态列表 + // ArrayList，使用切片模拟动态列表 OurPetList []ReadyFightPetInfo `fieldDesc:"我方携带精灵的信息" serialize:"lengthFirst,lengthType=uint16,type=structArray"` // 对方信息 @@ -36,34 +36,34 @@ type NoteReadyToFightInfo struct { OpponentPetList []ReadyFightPetInfo `fieldDesc:"敌方的精灵信息 如果是野怪 那么再给客户端发送这个包体时就提前生成好了这只精灵的PetInfo,然后把从PetInfo中把部分信息写入到这个敌方的精灵信息中再发送这个包结构体" serialize:"lengthFirst,lengthType=uint16,type=structArray"` } -// ReadyFightPetInfo 准备战斗的精灵信息结构体，对应Java的ReadyFightPetInfo类 +// ReadyFightPetInfo 准备战斗的精灵信息结构体，ReadyFightPetInfo类 type ReadyFightPetInfo struct { - // 精灵ID，对应Java的@UInt long + // 精灵ID，@UInt long ID uint32 `fieldDesc:"精灵ID" ` - // 精灵等级，对应Java的@UInt long + // 精灵等级，@UInt long Level uint32 `fieldDesc:"精灵等级" ` - // 精灵当前HP，对应Java的@UInt long + // 精灵当前HP，@UInt long Hp uint32 `fieldDesc:"精灵HP" ` - // 精灵最大HP，对应Java的@UInt long + // 精灵最大HP，@UInt long MaxHp uint32 `fieldDesc:"最大HP" ` SkillListLen uint32 // 技能信息列表（固定4个元素，技能ID和剩余PP，无技能则为0） - // 对应Java的List，初始化容量为4 + // List，初始化容量为4 SkillList [4]model.SkillInfo `fieldDesc:"技能信息 技能ID跟剩余PP 固定32字节 没有给0" serialize:"fixedLength=4,type=structArray"` - // 精灵捕获时间，对应Java的@UInt long + // 精灵捕获时间，@UInt long CatchTime uint32 `fieldDesc:"精灵捕获时间" ` - // 捕捉地图（固定给0），对应Java的@UInt long + // 捕捉地图（固定给0），@UInt long CatchMap uint32 `fieldDesc:"捕捉地图 给0" ` - // 固定给0，对应Java的@UInt long + // 固定给0，@UInt long CatchRect uint32 `fieldDesc:"给0" ` - // 固定给0，对应Java的@UInt long + // 固定给0，@UInt long CatchLevel uint32 `fieldDesc:"给0" ` SkinID uint32 `fieldDesc:"精灵皮肤ID" ` Shiny uint32 `fieldDesc:"精灵是否闪" ` diff --git a/logic/service/login/create_player.go b/logic/service/login/create_player.go index d4f17c97e..61ea93608 100644 --- a/logic/service/login/create_player.go +++ b/logic/service/login/create_player.go @@ -5,9 +5,9 @@ import "blazing/common/socket/handler" type CreatePlayerInboundInfo struct { //这里直接使用组合来实现将传入的原始头部数据和结构体参数序列化 Head handler.TomeeHeader `cmd:"108" struc:"[0]pad"` //玩家登录 - // 玩家昵称，对应Java的@ArraySerialize注解 + // 玩家昵称，@ArraySerialize注解 Nickname string `struc:"[16]byte"` // 固定长度16字节 - // 机器人人物颜色 rgb，对应Java的@UInt注解 + // 机器人人物颜色 rgb，@UInt注解 Color uint32 `fieldDescription:"机器人人物颜色 rgb" uint:"true"` } type CreatePlayerOutInfo struct { diff --git a/logic/service/maps/mapin.go b/logic/service/maps/mapin.go index d33916432..b451f504f 100644 --- a/logic/service/maps/mapin.go +++ b/logic/service/maps/mapin.go @@ -35,7 +35,7 @@ func (t *InInfo) Broadcast(mapid uint32, o OutInfo) { // 这里存储星球的map //var planetmap utils.SyncMap[] //= space.NewSyncMap() -// PeopleInfo 对应Java的PeopleInfo类，实现OutboundMessage接口 +// PeopleInfo PeopleInfo类，实现OutboundMessage接口 type OutInfo struct { UserID uint32 `struc:"uint32" fieldDesc:"米米号" json:"user_id"` diff --git a/logic/service/room/FitmentShowInfo.go b/logic/service/room/FitmentShowInfo.go index b0c3d4e0c..e6e80b2c8 100644 --- a/logic/service/room/FitmentShowInfo.go +++ b/logic/service/room/FitmentShowInfo.go @@ -16,14 +16,14 @@ type FitmentShowInfo struct { Status uint32 `json:"status"` } -// FitmentUseringInboundInfo 对应Java的FitmentUseringInboundInfo类，实现InboundMessage接口 +// FitmentUseringInboundInfo FitmentUseringInboundInfo类，实现InboundMessage接口 type FitmentUseringInboundInfo struct { Head handler.TomeeHeader `cmd:"10006" struc:"[0]pad"` //玩家登录 // 需要获取基地信息的目标玩家账号ID TargetUserID uint32 `json:"targetUserId"` } -// FitmentUseringOutboundInfo 对应Java的FitmentUseringOutboundInfo，实现OutboundMessage接口 +// FitmentUseringOutboundInfo FitmentUseringOutboundInfo，实现OutboundMessage接口 type FitmentUseringOutboundInfo struct { // 玩家账号ID UserId uint32 ` json:"userId"` diff --git a/logic/service/space/walk.go b/logic/service/space/walk.go index 720476081..e9be2b70b 100644 --- a/logic/service/space/walk.go +++ b/logic/service/space/walk.go @@ -8,7 +8,7 @@ import ( type InInfo struct { Head handler.TomeeHeader `cmd:"2101" struc:"[0]pad"` //走路包 - // Flag: 0为走，1为飞行模式，对应Java的@UInt long + // Flag: 0为走，1为飞行模式，@UInt long Flag uint32 // Point: 直接给坐标x，y @@ -32,7 +32,7 @@ func (t *InInfo) Broadcast(mapid uint32, o OutInfo) { }) } -// PeopleWalkOutboundInfo 对应Java的PeopleWalkOutboundInfo类，实现OutboundMessage接口 +// PeopleWalkOutboundInfo PeopleWalkOutboundInfo类，实现OutboundMessage接口 type OutInfo struct { // Flag: 0为走，1为飞行模式 Flag uint32 `fieldDesc:"0为走，1为飞行模式" codec:"uint"` diff --git a/logic/service/systemtime/System.go b/logic/service/systemtime/System.go index c82513b40..8cd7c40e1 100644 --- a/logic/service/systemtime/System.go +++ b/logic/service/systemtime/System.go @@ -13,7 +13,7 @@ type InInfo struct { //这里直接使用组合来实现将传入的原始头部 // OutInfo 表示系统时间的出站消息 type OutInfo struct { - SystemTime uint32 `json:"systemTime"` // 对应Java的@UInt long类型 + SystemTime uint32 `json:"systemTime"` // @UInt long类型 } // NewOutInfo 创建新的系统时间消息实例 diff --git a/modules/blazing/model/TeamInfo.go b/modules/blazing/model/TeamInfo.go index 7e3ccbc0a..fd1fb4263 100644 --- a/modules/blazing/model/TeamInfo.go +++ b/modules/blazing/model/TeamInfo.go @@ -23,8 +23,8 @@ func (t *TeamInfo) InitDefaults() { // TeamPKInfo 战队PK相关信息结构 type TeamPKInfo struct { - GroupID uint32 `struc:"uint32" default:"1"` // 分组ID，默认值1（对应Java的@UInt long） - HomeTeamID uint32 `struc:"uint32" default:"1"` // 主队ID，默认值1（对应Java的@UInt long） + GroupID uint32 `struc:"uint32" default:"1"` // 分组ID，默认值1（@UInt long） + HomeTeamID uint32 `struc:"uint32" default:"1"` // 主队ID，默认值1（@UInt long） } // InitDefaults 初始化默认值（确保字段默认值正确赋值） diff --git a/modules/blazing/model/pet.go b/modules/blazing/model/pet.go index 70517df20..fb725a7c0 100644 --- a/modules/blazing/model/pet.go +++ b/modules/blazing/model/pet.go @@ -115,10 +115,10 @@ type PetEffectInfo struct { Reserve4 [13]byte `struc:"[13]byte" json:"reserve4"` } -// SkillInfo 精灵技能信息结构（对应Java的SkillInfo） +// SkillInfo 精灵技能信息结构（SkillInfo） type SkillInfo struct { - ID uint32 `struc:"uint32"` // 技能id（对应Java的@UInt long） - Pp uint32 `struc:"uint32"` // 剩余pp（对应Java的@UInt long） + ID uint32 `struc:"uint32"` // 技能id（@UInt long） + Pp uint32 `struc:"uint32"` // 剩余pp（@UInt long） } // TableName Pet's table name diff --git a/modules/blazing/model/player.go b/modules/blazing/model/player.go index eae9c0da4..8b172f688 100644 --- a/modules/blazing/model/player.go +++ b/modules/blazing/model/player.go @@ -18,10 +18,10 @@ type Pos struct { Y uint32 `struc:"uint32" default:"0"` } -// PeopleItemInfo 穿戴装备信息结构（对应Java的PeopleItemInfo） +// PeopleItemInfo 穿戴装备信息结构（PeopleItemInfo） type PeopleItemInfo struct { ID uint32 `struc:"uint32"` // 装备id - Level uint32 `struc:"uint32" default:"1"` // 未知字段（默认值1，对应Java的@Builder.Default） + Level uint32 `struc:"uint32" default:"1"` // 未知字段（默认值1，@Builder.Default） } // InitDefaults 初始化默认值（确保默认值正确赋值）