%%%-------------------------------------------------------------------
%%% @author liufenglin
%%% @copyright (C) 2017, liufenglin
%%% @doc
%%% 联盟副本协议
%%% @end
%%%-------------------------------------------------------------------
-module(proto_213).

-export([
		info/0
		,cfg/0
	]
).
-include("protocol.hrl").

info() -> {
		"联盟副本协议"
		,["common.hrl", "formation.hrl", "guild_dun.hrl", "combat.hrl"]
	}.

cfg() ->
	[
     #rpc{
          code = 21300
          ,log_title = "请求联盟副本信息"
          , req_desc = "请求联盟副本信息"
          , req = []
          , reply_desc = "返回联盟副本信息"
          , reply =
              [
                    {uint32, fid, "当前挑战副本ID"}
                    ,{uint32, max_id, "历史最高副本ID"}
                    ,{uint32, count, "剩余挑战次数"}
                    ,{uint16, buy_count, "第几次购买"}
                    ,{array, tuple, info, "联盟章节信息", [
                        {uint32, boss_id, "Boss id"}
                        ,{uint32, hp, "剩余血量"}
                    ]}
                    ,{array, tuple, combat_info, "boss伤害信息", [
                        {uint32, boss_id, "Boss id"}
                        ,{uint32, dps,  "扫荡伤害量 (0:不能扫荡)"}
                    ]}
                    ,{uint16, buff_lev, "buff等级"}
                    ,{uint32, buff_end_time, "buff结束时间戳"}
                    ,{uint32, ref_time, "副本重置时间"}
                    ,{uint32, worship, "今日已点赞次数"}
                    ,{uint32, coldtime, "集结冷却结束时间戳"}
              ]
         }
     , #rpc{
            code = 21303
            ,log_title = "请求联盟章节宝箱"
            , req_desc = "请求联盟章节宝箱"
            , req = []
            , reply_desc = "联盟章节宝箱"
            , reply =
                [
                  {array, tuple, box_list, "联盟章节宝箱(当天之前通关且当天无法挑战的章节返回空列表)", [
                      {uint32, fid,     "章节id"}
                      ,{uint32, num,     "数量"}
                 ]}
                ]
           }
    , #rpc{
            code = 21304
            ,log_title = "领取联盟章节宝箱"
            , req_desc = "领取联盟章节宝箱"
            , req = [
                     {uint32, fid, "联盟章节ID"}
                    ]
            , reply_desc = "领取联盟章节宝箱"
            , reply =
                [
                    {uint8, code,  "结果(0:失败 1:成功)"}
                    ,{string,  msg, "结果信息"}
                    ,{uint32, fid, "联盟章节ID"}
                    ,{uint32, num,     "数量"}
                ]
           }
    , #rpc{
            code = 21305
            ,log_title = "加buff"
            , req_desc = "加buff"
            , req = [
                    ]
            , reply_desc = "加buff"
            , reply =
                [
                    {uint8, code,  "结果(0:失败 1:成功)"}
                    ,{string,  msg, "结果信息"}
                ]
           }
    , #rpc{
        code = 21308
        , log_title = "挑战联盟副本"
        , req_desc = "挑战联盟副本"
        ,req = [
            {uint32, boss_id,  "BossID"}
            ,{uint16, formation_type, "阵法类型"}
            ,{array, formation_pos, pos_info, "阵法信息", ?p_g_set(formation_pos_p, [
                {uint8, pos, "位置"}
                ,{uint32, id, "伙伴id"}
            ])}
            ,{uint32, hallows_id, "神器id"}
        ]
        ,reply_desc = "挑战副本结果"
        ,reply = [
            {uint8, code, "是否成功"},
            {string, msg, "附加信息"}
        ]
    }
    ,#rpc{
         code = 21309
         , log_title = "战斗结果"
         ,reply_desc = "战斗结果"
         ,reply = [
              {uint32,    bossid,   "bossid"}
              ,{uint32, all_dps, "总伤害"}
              ,{uint32, best_partner, "最佳伙伴唯一ID"}
              ,{array, tuple, award_list, "奖励", [
                    {uint32, bid, "物品bid"}
                    ,{uint32, num, "个数"}
                  ]}
            ,{string,   target_role_name,   "对方名字"}
            ,{array, tuple, hurt_statistics, "伤害统计", [
                {uint8, type, "1:进攻方  2:被攻击方"}
                ,{array, partner_hurt, partner_hurts, "伤害统计", [
                    {tuple,  master_id, [
                        {uint32, rid,  "拥有者ID"}
                        ,{string, srvid, "拥有者服务器id"}
                    ]}
                    ,{uint32, id, id, "英雄bid"}
                    ,{uint32, bid, bid, "英雄bid"}
                    ,{uint32, star, star, "星级"}
                    ,{uint32, lev, lev, "等级"}
                    ,{uint32, camp_type, camp_type, "英雄阵营"}
                    ,{uint32, dps, dps, "英雄伤害"}
                    ,{uint32, cure, cure, "英雄治疗量"}
                    ,{array, tuple, ext_data, "额外参数", [
                        {uint32, key, "键（5:皮肤id）"}
                        ,{uint32, val, "值"}
                    ]}
                    ,{uint32, be_hurt, be_hurt, "英雄承受伤害"}
                ]}
            ]}
         ]
     }
    ,#rpc{
        code = 21312
        ,log_title = "请求购买挑战次数"
        ,req_desc = "请求购买挑战次数"
        ,req = [
            {uint8, type, "购买类型"}
        ]
        ,reply_desc = "购买挑战次数"
        ,reply = [
            {uint8, code, "是否成功"}
            ,{string, msg, "附加信息"}
            ,{uint16, count, "剩余挑战次数"}
            ,{uint16, buy_count, "第几次购买"}
            ,{uint8, type, "购买类型"}
        ]
    }
    ,#rpc{
        code = 21317
        ,log_title = "扫荡"
        ,req_desc = "扫荡"
        ,req = [
                {uint32, boss_id,  "BossID"}
        ]
        ,reply_desc = "扫荡"
        ,reply = [
            {uint8, code, "是否成功"}
           ,{string, msg, "附加信息"}
           ,{uint32, do_count,  "扫荡次数"}
           ,{uint32, all_dps, "总伤害"}
           ,{uint32, best_partner, "最佳伙伴唯一ID"}
           ,{array, tuple, award_list, "奖励", [
                {uint32, bid, "物品bid"}
                ,{uint32, num, "个数"}
             ]}
            ,{string,   target_role_name,   "对方名字"}
            ,{array, tuple, hurt_statistics, "伤害统计", [
                {uint8, type, "1:进攻方  2:被攻击方"}
                ,{array, partner_hurt, partner_hurts, "伤害统计", [
                    {tuple,  master_id, [
                        {uint32, rid,  "拥有者ID"}
                        ,{string, srvid, "拥有者服务器id"}
                    ]}
                    ,{uint32, id, id, "英雄bid"}
                    ,{uint32, bid, bid, "英雄bid"}
                    ,{uint32, star, star, "星级"}
                    ,{uint32, lev, lev, "等级"}
                    ,{uint32, camp_type, camp_type, "英雄阵营"}
                    ,{uint32, dps, dps, "英雄伤害"}
                    ,{uint32, cure, cure, "英雄治疗量"}
                    ,{array, tuple, ext_data, "额外参数", [
                        {uint32, key, "键（5:皮肤id）"}
                        ,{uint32, val, "值"}
                    ]}
                    ,{uint32, be_hurt, be_hurt, "英雄承受伤害"}
                ]}
            ]}
        ]
    }
    ,#rpc{
        code = 21318
        ,log_title = "请求联盟副本伤害联盟排行榜"
        ,req_desc = "请求联盟副本伤害联盟排行榜"
        ,req = [
        ]
        ,reply_desc = "联盟排行榜"
        ,reply = [
            {string, my_name, "自身联盟名字"}
           ,{uint32, my_rank, "自身联盟排名(0:未上榜)"}
           ,{uint8, my_max_id, "自身联盟最高章节"}
           ,{uint32, my_dps, "自身联盟每日总伤害"}
           ,{tuple,  r_id, [
                      {uint32, r_rid,  "盟主ID"}
                      ,{string, r_srvid, "盟主服务器ID"}
                    ]}
           ,{string, r_name, "盟主名"}
           ,{uint32, face_id, "盟主头像id"}
           ,{uint32, lev, "盟主等级"}
           ,{uint32, power, "盟主战力"}
           ,{uint32,    avatar_bid,   "盟主头像框基础id"}
           ,{array, guild_dun_rank_guild, rank_guild, "排行信息", [
                  {string, name, "联盟名"}
                 ,{uint8, rank, "排名"}
                 ,{string, r_name, "盟主名"}
                 ,{uint32, max_id, "最高章节"}
                 ,{uint32, day_dps, "联盟每日总伤害"}
            ]}
        ]
    }
    ,#rpc{
        code = 21319
        ,log_title = "请求联盟副本伤害个人排行榜"
        ,req_desc = "请求联盟副本伤害个人排行榜"
        ,req = [
            {uint32, boss_id, "boss_id"}
            ,{uint32, start_num, "起始排名"}
            ,{uint32, end_num, "最大排名"}
        ]
        ,reply_desc = "个人排行榜"
        ,reply = [
            {uint32, rank, "自身排名"}
            ,{uint32, mydps, "自身dps"}
            ,{uint32,  worship, "被点赞数量"}
            ,{uint32, day_worship, "今日已点赞次数"}
            ,{array, tuple, rank_list, "排行榜", [
                {rec, guild_dun_rank_role, guild_dun_rank_role, [
                  {uint32, rank, "排名"}
                  ,{tuple,  r_id, [
                      {uint32, r_rid,  "ID"}
                      ,{string, r_srvid, "服务器ID"}
                    ]}
                  ,{string, name, "名字"}
                  ,{string, family_name, "所在联盟名名字"}
                  ,{uint32, all_dps, "伤害量"}
                  ,{uint32, face_id, "头像id"}
                  ,{uint32, lev, "等级"}
                  ,{uint32, power, "战力"}
                  ,{uint32,    avatar_bid,   "头像框基础id"}
                  ,{uint32, look_id, "形象id"}
                  ,{uint32, face_update_time, "自定义头像时间"}
                  ,{string, face_file, "自定义头像"}
                ]}
              ,{uint32,  worship, "点赞数量"}
              ,{uint8,   worship_status, "膜拜状态(0:可膜拜 1:不可膜拜)"}
             ]}
        ]
    }
    , #rpc{
          code = 21320
          ,log_title = "请求联盟章节首通奖励"
          , req_desc = "请求联盟章节首通奖励"
          , req = []
          , reply_desc = "联盟章节首通奖励"
          , reply =
          [
              {array, tuple, award_list, "已领取宝箱", [
                  {uint32, fid, "联盟章节ID"}
                  ,{uint8,  status ,  "领取情况(0:未达成, 1:可领取, 2:已领取)"}
              ]}
          ]
    }
    , #rpc{
          code = 21321
          ,log_title = "领取联盟章节首通奖励"
          , req_desc = "领取联盟章节首通奖励"
          , req = [{uint32, fid, "联盟章节ID"}]
          , reply_desc = "领取联盟章节首通奖励"
          , reply =
          [
              {uint32, fid, "联盟章节ID"}
              ,{uint8, code,  "结果(0:失败 1:成功)"}
              ,{string,  msg, "结果信息"}
          ]
    }
    ,#rpc{
          code = 21322
          ,log_title = "推送双倍时间开启"
          ,req_desc = "推送双倍时间开启"
          ,req = [
          ]
          ,reply = [
              {uint8, code, "标志(0:关闭 1:开启)"}
          ]
    }
    ,#rpc{
          code = 21323
          ,log_title = "发起集结"
          ,req_desc = "发起集结"
          ,req = [
          ]
          ,reply = [
              {uint8,  code,   "标志(0:失败 1:成功)"}
              ,{string, msg,   "提示信息"}
              ,{uint32, coldtime, "冷却结束时间"}
          ]
    }
	].