%%----------------------------------------------------
%  排行榜相关
%% @author whjing2011@gmail.com
%%----------------------------------------------------
-module(proto_129).
-export([info/0, cfg/0]).
-include("protocol.hrl").

info() ->
    {
     "排行榜协议"
     ,["rank.hrl", "guild.hrl"]
    }.

cfg() -> [
    #rpc{
       code = 12900
       ,log_title = "请求排行榜数据"
       ,req_desc = "请求排行榜数据"
       ,req = [
            {uint16,  type,  "排行榜类型"}
            ,{uint8,  start,  "开始位置(1-100)"}
            ,{uint8,  num,    "数据量"}
            ,{uint8, is_cluster, "是否跨服 1是 0否"}
        ]
       ,reply_desc = "请求排行榜数据结果"
       ,reply = ?p_g_set(common_rank, [
            {uint8, is_cluster, "是否跨服 1是 0否"}
            ,{uint16,  type,  "排行榜类型"}
            ,{uint8,  start,  "开始位置(1-100)"}
            ,{uint8,  num,    "数据量"}
            ,{uint8,  len,    "总数据量"}
            ,{uint32, time,   "最后更新时间(0不用缓存)"}
            ,{uint16, my_idx, "自己的排名"}
            ,{uint8,  lev,    "等级"}
            ,{uint16, face_id, "头像ID"}
            ,{uint16, avatar_bid, "头像框基础ID"}
            ,{string, name,    "角色名"}
            ,{uint32, my_val1, "自己的数值1"}
            ,{uint32, my_val2, "自己的数值2"}
            ,{uint32, my_val3, "自己的数值3"}
            ,{array, rank_rc, rank_list, "排行榜数据", [
                 {uint32,   rid,    "角色ID"}
                 ,{string,  srv_id, "服务器ID"}
                 ,{string,  name, "角色名"}
                 ,{string,  guild_name, "公会名"}
                 ,{uint8,   lev, "等级"}
                 ,{uint32,  face_id, "头像"}
                 ,{uint32, avatar_bid, "头像框基础Id"}
                 ,{uint32,  val1, "数值1"}
                 ,{uint32,  val2, "数值2"}
                 ,{uint32,  val3, "数值3"}
                 ,{uint8,   idx, "名次"}
                 ,{string,  desc, "描述"}
                 ,{uint32,  look_id, "形象id"}
                 ,{uint32, face_update_time, "自定义头像时间"}
                 ,{string, face_file, "自定义头像"}
            ]}
            ,{uint32, face_update_time, "自定义头像时间"}
            ,{string, face_file, "自定义头像"}
        ])
    }
    ,#rpc{
        code = 12901
        ,log_title = "指定排行榜最后更新时间"
        ,req_desc = "指定排行榜最后更新时间(当本地存在数据缓存时调用)"
        ,req = [
            {uint16,  type,   "排行榜类型"}
            ,{uint8, is_cluster, "是否跨服 1是 0否"}
        ]
        ,reply_desc = "指定排行榜最后更新时间"
        ,reply = [
            {uint8, is_cluster, "是否跨服 1是 0否"}
            ,{uint16,  type,   "排行榜类型"}
            ,{uint32, time,   "最后更新时间"}
        ]
    }
    ,#rpc{
        code = 12902
        ,log_title = "排行榜界面数据"
        ,req_desc = "排行榜界面数据"
        ,req = [
            {uint8, is_cluster, "是否跨服 1是 0否"}
        ]
        ,reply_desc = "请求排行榜数据结果"
        ,reply = [
              {uint8, is_cluster, "是否跨服 1是 0否"}
              ,{array, tuple, rank_list, "排行榜数据", [
                  {uint16,  type,   "排行榜类型"}
                  ,{tuple, rank_rc, [
                      {string,  name, "角色名"}
                      ,{uint32,   rid,    "角色ID"}
                      ,{string,  srv_id, "服务器ID"}
                      ,{string,  guild_name, "公会名"}
                      ,{uint32,  face_id, "头像"}
                      ,{uint32, avatar_bid, "头像框基础Id"}
                      ,{uint32,  val1, "数值1"}
                      ,{uint32,  val2, "数值2"}
                      ,{uint32,  val3, "数值3"}
                      ,{uint32, face_update_time, "自定义头像时间"}
                      ,{string, face_file, "自定义头像"}
                  ]}
              ]}
        ]
    }
    ,#rpc{
       code = 12903
       ,log_title = "请求联盟排行榜数据"
       ,req_desc = "请求联盟排行榜数据"
       ,req = [
            {uint8,  start,  "开始位置(1-100)"}
            ,{uint8,  num,    "数据量"}
            ,{uint8, is_cluster, "是否跨服 1是 0否"}
        ]
       ,reply_desc = "请求排行榜数据结果"
       ,reply = [
            {uint8,   start,   "开始位置(1-100)"}
            ,{uint8,  num,     "数据量"}
            ,{uint8,  len,     "总数据量"}
            ,{uint32, time,    "最后更新时间(0不用缓存)"}
            ,{uint16, my_idx,  "自己的排名"}
            ,{string, gname,    "联盟名"}
            ,{string, leader_name, "会长名"}
            ,{uint8,  glev,    "联盟等级"}
            ,{uint32, power,    "总战力"}
            ,{array, guild_rank, rank_list, "排行榜数据", [
                 {string,   name, "联盟名"}
                 ,{uint8,   lev, "联盟等级"}
                 ,{uint8,   members_num, "联盟人数"}
                 ,{uint8,   members_max, "联盟最大人数"}
                 ,{string,  leader_name, "会长名"}
                 ,{uint32,  power, "战力"}
                 ,{uint8,   index, idx, "名次"}
                 ,{tuple,  leader_id, [
                      {uint32, leader_rid,  "盟主ID"}
                      ,{string, leader_srvid, "盟主服务器ID"}
                ]}
                 ,{uint32,  leader_face,  "盟主头像"}
                 ,{uint8,   leader_lev,   "盟主等级"}
                 ,{uint32,  leader_avatar_bid, "盟主头像框"}
                 ,{uint32,  leader_look_id, "盟主形象id"}
                 ,{uint32,  leader_face_update_time, "自定义头像时间"}
                 ,{string,  leader_face_file, "自定义头像"}
            ]}
        ]
    }
    ,#rpc{
        code = 12904
        ,log_title = "请求七天英雄排行榜数据"
        ,req_desc = "请求七天英雄排行榜数据"
        ,req = [
            {uint8,  start,  "开始位置(1-100)"}
            ,{uint8,  num,    "数据量"}
        ]
        ,reply_desc = "请求排行榜数据结果"
        ,reply = [
            {uint8,   start,  "开始位置(1-100)"}
            ,{uint8,  num,    "数据量"}
            ,{uint8,  len,    "总数据量"}
            ,{uint32, time,   "最后更新时间(0不用缓存)"}
            ,{uint16, my_idx, "自己的排名"}
            ,{uint8,  lev,    "等级"}
            ,{uint16, face_id, "头像ID"}
            ,{uint32, avatar_bid, "头像框基础Id"}
            ,{string, name,    "角色名"}
            ,{uint16, pid,        "伙伴ID"}
            ,{uint16, pbid,       "伙伴基础ID"}
            ,{uint8,  plev,       "等级"}
            ,{uint8,  pquality,   "品质"}
            ,{uint8,  pstar,      "星数"}
            ,{uint32, power,  "战力"}
            ,{uint32, face_update_time, "自定义头像时间"}
            ,{string, face_file, "自定义头像"}
            ,{array, tuple, rank_list, "排行榜数据", [
                {uint32,   rid,    "角色ID"}
                ,{string,  srv_id, "服务器ID"}
                ,{string,  name, "角色名"}
                ,{uint8,   lev, "等级"}
                ,{uint32,  face_id, "头像"}
                ,{uint32, avatar_bid, "头像框基础Id"}
                ,{uint32,  power, "战力"}
                ,{uint8,   idx, "名次"}
                ,{uint16, pid,        "伙伴ID"}
                ,{uint16,  pbid,       "伙伴基础ID"}
                ,{uint8,   plev,       "等级"}
                ,{uint8,   pquality,   "品质"}
                ,{uint8,   pstar,      "星数"}
                ,{uint32,  look_id, "形象id"}
            ]}
        ]
    }

].