开发者文档

API

道具模块所对外暴露的所有API

    /**
     * 获取所有队伍信息
     * @return 所有队伍
     */
    List<ITeam> getTeamAll();

    /**
     * 根据队伍ID获取队伍信息
     * @param teamId 队伍ID
     * @return 队伍信息
     */
    ITeam getTeamById(String teamId);

    /**
     * 获取玩家队伍数据
     * @param uuid 玩家ID
     * @return 玩家队伍数据
     */
    IUserTeamInfo getUserTeamById(String uuid);

    /**
     * 传送一个队伍到指定地点
     * @param teamId 队伍ID
     * @param location 具体坐标
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void teleportTeam(String teamId, Location location) throws ServiceErrorSendMsgException;

    /**
     * 获取这个队伍的最大人数
     * @param teamId 队伍ID
     * @return 最大人数
     */
    int getTeamMaxAmountByTeamId(String teamId);

    /**
     * 获取默认队伍类型
     * @return 获取默认队伍类型
     */
    String getDefTeamType();

    /**
     * 是否服务器关闭了队伍伤害
     * @return 布尔
     */
    boolean isTurnOffTeammateDamage();

    /**
     * 创建一个队伍
     * @param uuid 玩家ID
     * @param name 队伍名称
     * @param info 队伍描述
     * @param type 队伍类型
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void createTeam(String uuid ,String name, String info, String type) throws ServiceErrorSendMsgException;

    /**
     * 邀请这个玩家加入队伍
     * @param uuid 玩家ID
     * @param uuid2 邀请者ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void invite(String uuid, String uuid2) throws ServiceErrorSendMsgException;

    /**
     * 接受这个玩家的邀请
     * @param uuid 玩家ID
     * @param uuid2 邀请者ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void accept(String uuid, String uuid2) throws ServiceErrorSendMsgException;

    /** 忽略这个玩家的邀请
     * @param uuid 玩家ID
     * @param uuid2 邀请者ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void ignore(String uuid, String uuid2) throws ServiceErrorSendMsgException;


    /**
     * 申请加入这个人的队伍
     * @param uuid 申请者
     * @param uuid2 队伍里的人
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void apply(String uuid, String uuid2) throws ServiceErrorSendMsgException;

    /**
     * 接受这个玩家的进队申请
     * @param uuid 接受者
     * @param uuid2 申请者
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void agree(String uuid, String uuid2) throws ServiceErrorSendMsgException;

    /**
     * 提出这个玩家
     * @param uuid 执行者
     * @param uuid2 被T者
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void kickOut(String uuid, String uuid2) throws ServiceErrorSendMsgException;

    /**
     * 忽略这个玩家的进队申请
     * @param uuid 忽略者
     * @param uuid2 申请者
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void elide(String uuid , String uuid2) throws ServiceErrorSendMsgException;

    /**
     * 设置队伍信息
     * @param team 队伍
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void setTeam(ITeam team) throws ServiceErrorSendMsgException;


    /**
     * 解散队伍
     * @param uuid 玩家ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void dismiss(String uuid) throws ServiceErrorSendMsgException;

    /**
     * 退出队伍
     * @param uuid 玩家ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的信息
     */
    void quit(String uuid) throws ServiceErrorSendMsgException;

事件

类名	说明
PlayerApplyTeamEvent	玩家向另一个玩家发送申请进队申请事件
PlayerDismissTeamEvent	队伍被解散事件
PlayerInviteTeamEvent	玩家邀请另一个玩家进入队伍事件
PlayerJoinTeamEvent	玩家进入队伍的事件
PlayerKickTeamEvent	玩家被T出队伍事件
PlayerQuitTeamEvent	玩家退出队伍事件