s_cherry_e/sr/_proto/map.json

[
  {
    "enable": true,
    "name": "[请求]玩家登录地图",
    "route": "map.player.login",
    "request": "None",
    "response": "MapLoginResponse",
    "@response": "登录地图只会返回一些进入地图前需要知道的必要信息，其它信息会 map.player.enter 接口返回",
    "desc1": "请求之后会收到玩家各个模块的数据推送",
    "desc2": "如果玩家加入了联盟，后续会收到联盟基础数据推送",
    "desc3": "以下联盟数据需要进入地图做展示前自己拉取",
    "desc4": "成员信息，科技信息，设施信息，城池信息"
  },
  {
    "enable": true,
    "name": "[请求]玩家进入地图",
    "route": "map.player.enter",
    "request": "None",
    "response": "MapEnterResponse",
    "@response": ""
  },
  {
    "enable": true,
    "name": "[请求]玩家以观察者身份进入地图",
    "route": "map.player.join",
    "notify": "None",
    "desc": "进入地图后会收到AOI更新的推送"
  },
  {
    "enable": true,
    "name": "[请求]玩家以观察者身份离开地图",
    "route": "map.player.quit",
    "notify": "None",
    "desc": "离开地图后不会收到AOI更新的推送"
  },
  {
    "enable": true,
    "name": "[通知]玩家滑动屏幕",
    "route": "map.player.slide",
    "notify": "Point",
    "desc": "移动屏幕时，传最新的地图格子的坐标点"
  },
  {
    "enable": true,
    "name": "[请求]行军",
    "route": "map.player.march",
    "request": "MapMarchRequest",
    "response": "I32",
    "@response": "返回状态码"
  },
  {
    "enable": true,
    "name": "[请求]行军撤退",
    "route": "map.player.retreat",
    "request": "I32I64",
    "@request": "key: 队伍ID, value: 撤退建筑ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "撤退建筑ID为0时, 默认撤退回主城"
  },
  {
    "enable": true,
    "name": "[请求]行军中止",
    "route": "map.player.marchStop",
    "request": "I32",
    "@request": "队伍ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求] 攻城集结",
    "route": "map.player.siegeAssemble",
    "request": "SiegeAssembleRequest",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]放弃对象",
    "route": "map.player.discard",
    "request": "I64I32",
    "@request": "key: 放弃对象ID, value: 放弃对象类型",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]取消放弃对象",
    "route": "map.player.discardCancel",
    "request": "I64I32",
    "@request": "key: 放弃对象ID, value: 放弃对象类型",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]建造个人建筑",
    "route": "map.player.build",
    "request": "MapBuildRequest",
    "response": "I64",
    "@response": "如果当前建造的是玩家地基 返回地基建造冷却时间戳 单位毫秒",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]升级个人建筑",
    "route": "map.player.buildUpgrade",
    "request": "MapBuildUpgradeRequest",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]迁城",
    "route": "map.player.relocate",
    "request": "I64",
    "@request": "地基对象ID",
    "response": "I64",
    "@response": "当次迁城冷却时间戳 单位毫秒",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]再起",
    "route": "map.player.comeback",
    "request": "I32Bool",
    "@request": "key: 州ID, value: 是否选州; 只有 value 为 true 时 key 为生效，为 false 表示本州再起",
    "response": "ComebackResponse",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]重新出生推送",
    "route": "map.player.rebornPush",
    "push": "RebornPush",
    "desc": "客户端收到推送可以弹窗，如果isFailed为true，弹窗提示重新出生。玩家离线再上线时也会收到推送"
  },
  {
    "enable": true,
    "name": "[请求]主城加固",
    "route": "map.player.reinforce",
    "request": "None",
    "response": "I64List",
    "@response": "返回三个时间戳 分别为 0.准备结束时间 1.加固生效结束时间 2.冷却结束时间",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]主城加固取消",
    "route": "map.player.reinforceCancel",
    "request": "None",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]获取各出生州信息",
    "route": "map.player.bornStateInfo",
    "request": "None",
    "response": "I32I32List",
    "@response": "出生州列表: key=stateID, value=人数",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]选择出生州",
    "route": "map.player.selectState",
    "request": "I32",
    "@request": "州ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]重新出生",
    "route": "map.player.reborn",
    "request": "None",
    "response": "Point",
    "@response": "出生坐标",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]重新出生",
    "route": "map.player.rebornPush",
    "Push": "None",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]资源守军恢复倒计时",
    "route": "map.player.resDefendRecoverPush",
    "push": "I64I64",
    "@push": "key为objectID , value为恢复倒计时(秒)",
    "desc": "资源守军恢复倒计时推送"
  },
  {
    "enable": true,
    "name": "[请求] 查看玩家行军对象部队信息",
    "route": "map.player.marchTeamInfo",
    "request": "I64",
    "@request": "行军对象ID",
    "response": "Team",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]获取资源守军",
    "route": "map.player.resArmies",
    "request": "I64",
    "response": "I32List",
    "@response": "返回怪物组列表",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]宣战",
    "route": "map.league.startWar",
    "request": "I64I64",
    "@request": "key: 城池对象ID, value: 宣战时间(分钟)",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]取消宣战",
    "route": "map.league.stopWar",
    "request": "I64",
    "@request": "攻城大营对象ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]战争列表",
    "route": "map.league.warList",
    "request": "None",
    "response": "WarList",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]战争更新推送",
    "route": "map.league.warUpdatePush",
    "push": "I32",
    "@push": "大于0表示有新的战争，等于0表示当前有战争更新，小于0表示有战争结束",
    "@push1": "部队人数变化时不推送，变化太频繁",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]获取攻城首占排行",
    "route": "map.player.siegeRank",
    "request": "I64",
    "@request": "建筑对象ID",
    "response": "SiegeRank",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]攻城结果推送",
    "route": "map.player.siegeResultPush",
    "push": "SiegeResult",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]获取集结列表",
    "route": "map.league.assembleList",
    "request": "None",
    "response": "MapAssembleList"
  },
  {
    "enable": true,
    "name": "[请求]发起集结",
    "route": "map.player.assemble",
    "@route": "TODO: 现在放在map.player这边好做，是因为request传了 teamID，后面让前端传ObjectID就可以统一到map.league这边",
    "request": "MapAssembleRequest",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "成功后推送消息给所有在线的盟友"
  },
  {
    "enable": true,
    "name": "[请求]加入集结",
    "route": "map.player.assembleJoin",
    "request": "MapAssembleJoinRequest",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "成功后推送消息给所有在线的盟友"
  },
  {
    "enable": true,
    "name": "[请求]集结取消",
    "route": "map.league.assembleStop",
    "request": "I64",
    "@request": "集结唯一ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "成功后推送消息给所有在线的盟友"
  },
  {
    "enable": true,
    "name": "[请求]踢出集结队伍",
    "route": "map.league.assembleKick",
    "request": "I64I64",
    "@request": "key: 集结唯一ID, value: 踢出对象ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "成功后推送消息给所有在线的盟友"
  },
  {
    "enable": true,
    "name": "[请求]集结立即出发",
    "route": "map.league.assembleDepart",
    "request": "I64",
    "@request": "集结唯一ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "出发后收到集结列表删除的推送"
  },
  {
    "enable": true,
    "name": "[请求]集结退出",
    "route": "map.league.assembleQuit",
    "request": "I64",
    "@request": "集结唯一ID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": "出发后收到集结列表删除的推送"
  },
  {
    "enable": true,
    "name": "[推送]集结更新",
    "route": "map.league.assembleUpdatePush",
    "push": "I32",
    "@push": "代表新增的集结数量, 正数代表新增, 负数代表删除",
    "desc": "集结信息更新时推送"
  },
  {
    "enable": true,
    "name": "[推送]更新地图对象",
    "route": "map.pusher.objectUpdate",
    "push": "MapObjects",
    "desc": "观察者移动屏幕时"
  },
  {
    "enable": true,
    "name": "[推送]地图对象ID删除",
    "route": "map.pusher.objectDel",
    "push": "I64List",
    "@push": "对象id列表",
    "desc": "对象id从地图离开时推送删除"
  },
  {
    "enable": true,
    "name": "[推送]地图行军状态推送",
    "route": "map.pusher.marchState",
    "push": "MapMarchState",
    "desc": "行军对象状态变化时推送"
  },
  {
    "enable": true,
    "name": "[推送]更新地图玩家信息",
    "route": "map.pusher.playerUpdate",
    "push": "MapPlayers",
    "desc": "观察者移动屏幕时，收到 map.pusher.objectUpdate 之前会收到这个"
  },
  {
    "enable": true,
    "name": "[推送]更新地图联盟信息",
    "route": "map.pusher.leagueUpdate",
    "push": "MapLeagues",
    "desc": "观察者移动屏幕时，收到 map.pusher.objectUpdate 之前会收到这个"
  },
  {
    "enable": true,
    "name": "[推送]地图标记列表",
    "route": "map.player.mapMarkPush",
    "push": "MapMarkList",
    "desc": "玩家登录推送"
  },
  {
    "enable": true,
    "name": "[请求]玩家地图标记",
    "route": "map.player.mapMark",
    "request": "MapMarkRequest",
    "response": "MapMark",
    "@response": "地图标记后的信息",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[请求]玩家地图标记删除",
    "route": "map.player.mapMarkDelete",
    "request": "I32",
    "@request": "需要删除地图标记ID markID",
    "response": "I32",
    "@response": "返回状态码",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]地图战斗推送",
    "route": "map.pusher.battle",
    "push": "MapBattlePush",
    "desc": "产生战斗结果后推送给AOI观察者"
  },
  {
    "enable": true,
    "name": "[推送]声望变更推送",
    "route": "map.player.prestigeChangePush",
    "push": "I32",
    "desc": "声望变更推送"
  },
  {
    "enable": true,
    "name": "[请求]查询寻路信息",
    "route": "map.player.findPath",
    "request": "MapFindPathRequest",
    "@request": "寻路的起点和终点",
    "response": "Points",
    "@response": "返回路径数组",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]玩家自己的资源列表",
    "route": "map.player.ownerMapObjectsPush",
    "push": "OwnerMapObjects",
    "@push": "自己的资源列表",
    "desc": "登录后推送列表"
  },
  {
    "enable": true,
    "name": "[推送]增加玩家自己的资源",
    "route": "map.player.ownerMapObjectAddPush",
    "push": "OwnerMapObject",
    "@push": "增加的资源",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]更新玩家自己的资源",
    "route": "map.player.ownerMapObjectUpdatePush",
    "push": "OwnerMapObject",
    "@push": "更新的资源",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]删除玩家自己的资源",
    "route": "map.player.ownerMapObjectDelPush",
    "push": "I64",
    "@push": "删除的资源",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]地图ui层-行军对象列表",
    "route": "map.player.mapUIMarchsPush",
    "push": "MapUIMarchs",
    "@push": "地图ui层-行军对象列表",
    "desc": "如果客户端本地对象已存在则更新"
  },
  {
    "enable": true,
    "name": "[推送]地图ui层-行军状态推送",
    "route": "map.pusher.mapUIMarchState",
    "push": "MapMarchState",
    "desc": "地图ui层行军对象状态变化时推送"
  },
  {
    "enable": true,
    "name": "[推送]地图ui层-系统城对象",
    "route": "map.player.mapUICastlesPush",
    "push": "MapUICastles",
    "@push": "图ui层-系统城对象",
    "desc": "如果客户端本地对象已存在则更新(该消息可能在未进入地图时推送"
  },
  {
    "enable": true,
    "name": "[请求]获取指定对象的坐标",
    "route": "map.player.mapObjectPosition",
    "request": "MapObjectPositionRequest",
    "@request": "获取指定对象的坐标",
    "response": "Point",
    "@response": "返回对象当前的坐标",
    "desc": ""
  },
  {
    "enable": true,
    "name": "[推送]侦察队列",
    "route": "map.player.mapScoutListPush",
    "push": "MapScoutList",
    "desc": "玩家登录推送侦察队列"
  },
  {
    "enable": true,
    "name": "[推送]侦察变更推送",
    "route": "map.player.mapScoutChangePush",
    "push": "MapScoutList",
    "desc": "侦察变更推送"
  },
  {
    "enable": true,
    "name": "[请求]发起侦察",
    "route": "map.player.mapScoutRequest",
    "request": "I32I64",
    "@request": "key使用侦察队列ID value 地块的objectID",
    "response": "MapScout",
    "@response": "地图侦察数据",
    "desc": ""
  }
]