%%----------------------------------------------------
%% 家园
%%
%% @author yzq
%%----------------------------------------------------
-module(proto_260).
-export([info/0, cfg/0]).
-include("protocol.hrl").

info() -> {
           "家园"
          ,["common.hrl", "home.hrl"]
          }.

-spec cfg() -> [#rpc{}].
cfg() ->
    [
        #rpc{
            code = 26001
            ,log_title = "房间基础"
            ,req = [
                {uint8, floor, "层数"}
            ]
            ,reply_desc = "房间基础"
            ,reply = [
                {string, name,  "家园名称"}
                ,{uint32, look_id, "角色形象ID"}
                ,{uint32, worship, "点赞数量"}
                ,{uint16, rest_worship, "剩余点赞次数"}
                ,{uint32,   soft,    "舒适度"}
                ,{uint32, wall_bid, "墙纸BID"}
                ,{uint32, land_bid, "地板BID"}
                ,{array, home_unit, list,  "家具列表", [
                    {uint32,    bid,            "家具基础ID"}
                    ,{uint32,   index,      "位置索引"}
                    ,{uint8,    dir,   "方向（若是墙壁道具，则1左墙 2右墙）"}
                ]}
                ,{array, tuple, visitors, "访问角色", [
                    {uint32,   rid,  "角色ID"}
                    ,{string,  srv_id,  "角色服务器ID"}
                    ,{string, name, "角色名"}
                    ,{uint32,  look_id, "形象ID"}
                ]}
                ,{uint32, acc_hook_time, "累计挂机时间（秒）"}
                ,{uint8, floor, "当前层数"}
                ,{uint8, main_floor, "主居层数"}
                ,{uint8, max_soft_floor, "最高舒适度楼层"}
                ,{uint32, max_all_soft, "所有层数最高舒适度"}
                ,{array, tuple, other_bid, "其他层已装饰家具", [
                    {uint32,    bid,  "家具基础ID"}
                    ,{uint32,    num, "家具数量"}
                ]}
                ,{uint32, max_floor_soft, "最高楼层舒适度"}
            ]
        }
        ,#rpc{
            code = 26002
            ,log_title = "家具摆放"
            ,req_desc = "家具摆放"
            ,req = [
                {uint32, wall_bid, "墙纸BID"}
                ,{uint32, land_bid, "地板BID"}
                ,{array, tuple, list, "摆放家具", [
                    {uint32,    bid,            "家具基础ID"}
                    ,{uint32,   index,      "位置索引"}
                    ,{uint8,    dir,   "方向（若是墙壁道具，则1左墙 2右墙）"}
                ]}
                ,{uint8, floor, "层数"}
            ]
            ,reply = [
                {uint8,  code,   "标志(0:失败 1:成功)"}
                ,{string, msg,   "提示信息"}
                ,{uint32, soft,    "舒适度"}
                ,{uint32, wall_bid, "墙纸BID"}
                ,{uint32, land_bid, "地板BID"}
                ,{array, tuple, list,  "家具列表", [
                    {uint32,    bid,            "家具基础ID"}
                    ,{uint32,   index,      "位置索引"}
                    ,{uint8,    dir,   "方向（若是墙壁道具，则1左墙 2右墙）"}
                ]}
                ,{uint8, floor, "层数"}
                ,{uint8, max_soft_floor, "最高舒适度楼层"}
                ,{uint32, max_all_soft, "所有层数最高舒适度"}
                ,{array, tuple, other_bid, "其他层已装饰家具", [
                    {uint32,    bid,  "家具基础ID"}
                    ,{uint32,    num, "家具数量"}
                ]}
                ,{uint32, max_floor_soft, "最高楼层舒适度"}
            ]
        }
        ,#rpc{
            code = 26003
            ,log_title = "访问别人家园"
            ,req_desc = "访问别人家园"
            ,req = [
                {uint32,   rid,  "角色ID"}
                ,{string,  srv_id,  "角色服务器ID"}
                ,{uint8, floor, "层数"}
            ]
            ,reply_desc = "房间基础"
            ,reply = [
                {uint8,  code,   "标志(0:失败 1:成功)"}
                ,{string, msg,   "提示信息"}
                ,{uint32,   rid,  "角色ID"}
                ,{string,  srv_id,  "角色服务器ID"}
                ,{string, name,  "家园名称"}
                ,{uint32, look_id, "角色形象ID"}
                ,{uint32, worship, "点赞数量"}
                ,{uint8,   worship_status, "点赞状态(0:可点赞 1:不可点赞)"}
                ,{uint32,   soft,    "舒适度"}
                ,{uint32, wall_bid, "墙纸BID"}
                ,{uint32, land_bid, "地板BID"}
                ,{array, home_unit, list,  "家具列表", [
                    {uint32,    bid,            "家具基础ID"}
                    ,{uint32,   index,      "位置索引"}
                    ,{uint8,    dir,   "方向（若是墙壁道具，则1左墙 2右墙）"}
                ]}
                ,{array, tuple, visitors, "访问角色", [
                    {uint32,   rid,  "角色ID"}
                    ,{string,  srv_id,  "角色服务器ID"}
                    ,{string, name, "角色名"}
                    ,{uint32,  look_id, "形象ID"}
                ]}
                ,{string, tar_name, "房主名字"}
                ,{uint8, floor, "层数"}
            ]
        }
        ,#rpc{
            code = 26004
            ,log_title = "形象信息"
            ,req_desc = "形象信息"
            ,req = []
            ,reply_desc = "形象信息"
            ,reply = [
                {uint32,  use_id,  "使用中的形象ID"}
                ,{uint32,  max_soft,  "最大的舒适度"}
                ,{array,  single,  list, "已激活形象列表", [
                    {uint32,  id,  "形象ID"}
                ]}
                ,{uint8, is_finish, "是否已完成前置"}
            ]
        }
        , #rpc{
            code = 26005
            ,log_title = "形象使用"
            ,req_desc = "形象使用"
            ,req = [
                {uint32,  id,  "使用形象ID"}
            ]
            ,reply_desc = "形象使用"
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{uint32,  id,  "使用形象ID"}
            ]
        }
        , #rpc{
            code = 26006
            ,log_title = "形象购买"
            ,req_desc = "形象购买"
            ,req = [
                {uint32,  id,  "形象ID"}
            ]
            ,reply_desc = "形象购买"
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{uint32,  id,  "购买形象ID"}
            ]
        }
        , #rpc{
            code = 26007
            ,log_title = "初始设置形象（用于引导）"
            ,req_desc = "初始设置形象（用于引导）"
            ,req = [
                {uint32,  id,  "形象ID"}
            ]
            ,reply_desc = "形象购买"
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{uint32,  id,  "购买形象ID"}
            ]
        }
        , #rpc{
            code = 26008
            ,log_title = "访问形象通知"
            ,reply_desc = "访问形象通知"
            ,reply = [
                {uint32,   rid,  "角色ID"}
                ,{string,  srv_id,  "角色服务器ID"}
                ,{string, name, "角色名"}
                ,{uint32,  look_id, "形象ID"}
            ]
        }
        , #rpc{
            code = 26009
            ,log_title = "随机访问对象"
            ,req = []
            ,reply_desc = "随机访问对象"
            ,reply = [
                {array, home_rand_visit, list, "随机角色", [
                    {tuple, id, [
                        {uint32,  rid,  "角色ID"}
                        ,{string, srv_id,  "服务器ID"}
                    ]}
                    ,{string, name,        "名称"}
                    ,{uint16,  lev,         "等级"}
                    ,{uint8,  sex,   "性别"}
                    ,{uint32, face,  "头像"}
                    ,{uint32, power,   "战力"}
                    ,{uint32, last_login,   "上次登陆时间"}
                    ,{uint32,   soft,    "舒适度"}

                    ,{uint32, face_update_time, "自定义头像时间"}
                    ,{string, face_file, "自定义头像"}
                ]}
            ]
        }
        , #rpc{
            code = 26010
            ,log_title = "日志"
            ,req = []
            ,reply_desc = "日志"
            ,reply = [
                {array, home_log, list, "日志", [
                    {tuple, id, [
                        {uint32,  rid,  "角色ID"}
                        ,{string, srv_id,  "服务器ID"}
                    ]}
                    ,{uint32, face, "头像"}
                    ,{uint16,  lev,         "等级"}
                    ,{string, name,        "名称"}
                    ,{uint8,  is_friend,   "是否好友"}
                    ,{uint8,  type,   "日志类型 1访问日志"}
                    ,{uint32, time,  "时间"}
                    ,{array, tuple, int_args, "整型参数", [
                        {uint32, key, "类型"}
                        ,{uint32, val, "数量"}
                    ]}
                    ,{array, tuple, str_args, "字符串参数", [
                        {uint32, key, "类型"}
                        ,{string, val, "数据"}
                    ]}
                    ,{uint32, face_update_time, "自定义头像时间"}
                    ,{string, face_file, "自定义头像"}
                ]}
            ]
        }
        , #rpc{
            code = 26011
            ,log_title = "改家园名"
            ,req_desc = "改家园名"
            ,req = [
                {string, name,   "家园名"}
            ]
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{string, name, "家园名"}
            ]
        }
        , #rpc{
            code = 26012
            ,log_title = "点赞数量变化"
            ,reply_desc = "点赞数量变化"
            ,reply = [
                {uint32, worship, "点赞数量"}
            ]
        }
        , #rpc{
            code = 26013
            ,log_title = "套装奖励情况"
            ,req = []
            ,reply_desc = "套装奖励情况"
            ,reply = [
                {array, home_unit_set, list,  "套装列表", [
                    {uint32,    set_id,     "套装ID"}
                    ,{array, single, reward, "该套装已领取的奖励ID", [
                        {uint32, id, "奖励ID"}
                    ]}
                    ,{array, single, collect, "该套装已拥有的家具BID", [
                        {uint32, bid, "家具BID"}
                    ]}
                ]}
            ]
        }
        , #rpc{
            code = 26014
            ,log_title = "领取套装奖励"
            ,req_desc = "领取套装奖励"
            ,req = [
                {uint32, id, "奖励ID"}
            ]
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{uint32, id, "奖励ID"}
            ]
        }
        , #rpc{
            code = 26015
            ,log_title = "部分数据变化"
            ,reply_desc = "部分数据变化"
            ,reply = [
                {uint16, rest_worship, "剩余点赞次数"}
                ,{uint32, acc_hook_time, "累计挂机时间（秒）"}
                ,{uint32,  max_soft,  "最大的舒适度"}
            ]
        }
        , #rpc{
            code = 26016
            ,log_title = "领取家园挂机奖励"
            ,req_desc = "领取家园挂机奖励"
            ,req = []
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
            ]
        }
        ,#rpc{
            code = 26017
            ,log_title = "第一次进入家园"
            ,req_desc = "第一次进入家园"
            ,req = [
            ]
            ,reply = [
                {uint8, is_first, "是否进入过, 1是 0否"}
            ]
        }
        ,#rpc{
            code = 26018
            ,log_title = "是否有红点（仅客户端上线请求）"
            ,req_desc = "是否有红点（仅客户端上线请求）"
            ,req = [
            ]
            ,reply = [
                {uint8, code, "访客记录标志(0:无 1:有)"}
                ,{uint8, hook_code, "挂机时间是否有红点"}
            ]
        }
        , #rpc{
            code = 26019
            ,log_title = "已点赞过的角色ID"
            ,req = []
            ,reply_desc = "已点赞过的角色ID"
            ,reply = [
                {array, tuple, list, "角色ID列表", [
                    {uint32,  rid,  "角色ID"}
                    ,{string, srv_id,  "服务器ID"}
                ]}
            ]
        }
        ,#rpc{
            code = 26020
            ,log_title = "排行榜"
            ,req_desc = "排行榜"
            ,req = [
            ]
            ,reply = [
                {uint16,   my_rank,   "自己名次"}
                ,{uint32, my_score,  "评分"}
                ,{array, home_rank_rc, rank_list, "排行榜", [
                    {tuple,   id,   [
                        {uint32, rid,        "角色ID"}
                        ,{string, srv_id,     "服务器ID"}
                    ]}
                    ,{string, name,       "名字"}
                    ,{uint16,  lev,        "等级"}
                    ,{uint32, face,       "头像"}
                    ,{uint16, rank,       "排名"}
                    ,{uint32, avatar_bid,  "头像框"}
                    ,{uint32, score,  "评分"}

                    ,{uint32, face_update_time, "自定义头像时间"}
                    ,{string, face_file, "自定义头像"}
                ]}
            ]
        }
        , #rpc{
            code = 26021
            ,log_title = "设置主居室"
            ,req_desc = "设置主居室"
            ,req = [
                {uint8, main_floor, "层数"}
            ]
            ,reply = [
                {uint8,   code,   "结果(0:失败 1:成功)"}
                ,{string, msg,   "结果信息"}
                ,{uint8, main_floor, "层数"}
                ,{uint8, max_soft_floor, "最高舒适度楼层"}
            ]
        }
    ,#rpc{
        code = 26031
        ,log_title = "房间基础"
        ,req = [
        ]
        ,reply_desc = "房间基础"
        ,reply = [
            {string, msg,   "结果信息"}
            ,{string, role_name,  "角色名称"}
            ,{uint32,   rid,  "角色ID"}
            ,{string,  srv_id,  "角色服务器ID"}
            ,{string, name,  "家园名称"}
            ,{uint32, look_id, "主题Id"}
            ,{array, single, look_list, "主题列表",
                [
                    {uint32, look_id, "奖励id"}
                ]
            }
            ,{uint32, visitor_num, "访问数量"}
            , {array, tuple, rewards, "奖励",
                [   {uint32, reward_id, "奖励id"}
                    ,{uint32, base_id, "基础id"}
                    , {uint32, num, "数量"}
                    , {uint32, icon, "图标"}
                ]
            }
            , {array, tuple, partner_bids, "伙伴基础id列表",
                [
                    {uint32, partner_bid, "伙伴基础id"}
                    ,{uint8,   init_star, "星级"}
                ]
            }
        ]
    }
        , #rpc{
        code = 26032
        ,log_title = "获取访客信息"
        ,req_desc = "获取访客信息"
        ,req = [

        ]
        ,reply = [
            {string, msg,   "结果信息"}
            ,{array, tuple, visitors, "访问角色", [
                {uint32,   rid,  "角色ID"}
                ,{string,  srv_id,  "角色服务器ID"}
                ,{string, name, "角色名"}
                ,{uint32, time, "访问时间"}
                ,{uint32, is_home, "是否开启家园， 1-开启，0-未开启"}
                , {array, tuple, rewards, "奖励",
                    [   {uint32, reward_id, "奖励id"}
                        ,{uint32, base_id, "基础id"}
                        , {uint32, num, "数量"}
                        , {uint32, icon, "图标"}
                    ]
                }
            ]}
        ]
    }, #rpc{
        code = 26033
        ,log_title = "推送奖励信息和家园伙伴信息"
        ,req_desc = "推送奖励信息和家园伙伴信息"
        ,req = [

        ]
        ,reply = [
            {uint32, look_id, "主题Id"}
            ,{array, single, look_list, "主题列表",
                [
                    {uint32, look_id, "奖励id"}
                ]
            }
            ,{array, tuple, rewards, "奖励",
                [   {uint32, reward_id, "奖励id"}
                    ,{uint32, base_id, "基础id"}
                    , {uint32, num, "数量"}
                    , {uint32, icon, "图标"}
                ]
            }
            , {array, tuple, partner_bids, "伙伴基础id列表",
                [
                    {uint32, partner_bid, "伙伴基础id"}
                    ,{uint8,   init_star, "星级"}
                ]
            }
        ]
    }
        , #rpc{
        code = 26034
        ,log_title = "领取奖励"
        ,req_desc = "领取奖励"
        ,req = [
            {uint32,   rid,  "角色ID"}
            ,{string,  srv_id,  "角色服务器ID"}
            ,{uint32, reward_id, "奖励id"}
        ]
        ,reply = [
            {string, msg,   "结果信息"}
        ]
    }
        , #rpc{
        code = 26035
        ,log_title = "改家园名"
        ,req_desc = "改家园名"
        ,req = [
            {string, name,   "家园名"}
        ]
        ,reply = [
            {uint8,   code,   "结果(0:失败 1:成功)"}
            ,{string, msg,   "结果信息"}
            ,{string, name, "家园名"}
        ]
    }
        ,#rpc{
        code = 26036
        ,log_title = "访问别人的家园"
        ,req = [
            {uint32,   rid,  "角色ID"}
            ,{string,  srv_id,  "角色服务器ID"}
        ]
        ,reply_desc = "访问别人的家园"
        ,reply = [
            {string, msg,   "结果信息"}
            ,{uint32,   rid,  "角色ID"}
            ,{string,  srv_id,  "角色服务器ID"}
            ,{string, name,  "家园名称"}
            ,{uint32, look_id, "主题Id"}
            ,{uint32, visitor_num, "访问数量"}
            , {array, tuple, rewards, "奖励",
                [   {uint32, reward_id, "奖励id"}
                    ,{uint32, base_id, "基础id"}
                    , {uint32, num, "数量"}
                    , {uint32, icon, "图标"}
                ]
            }
            , {array, tuple, partner_bids, "伙伴基础id列表",
                [
                    {uint32, partner_bid, "伙伴基础id"}
                    ,{uint8,   init_star, "星级"}
                ]
            }
        ]
    }
        , #rpc{
        code = 26037
        ,log_title = "更换家园主题"
        ,req_desc = "更换家园主题"
        ,req = [
            {uint32, look_id,   "家园名"}
        ]
        ,reply = [
            {uint8,   code,   "结果(0:失败 1:成功)"}
            ,{string, msg,   "结果信息"}
            ,{uint32, look_id, "主题Id"}
        ]
    }
        ,#rpc{
        code = 26038
        ,log_title = "是否有访客红点）"
        ,req_desc = "是否有访客红点"
        ,req = [
        ]
        ,reply = [
            {uint8, code, "访客记录标志(0:无 1:有)"}
        ]
    }
    ].