开发者文档

API

视图核心库模块所对外暴露的所有API

    /**
     * 获取所有图片尺寸比例
     * @return
     */
    default double getProportion(){
        return 1;
    }

    /**
     * 给一个玩家发送对话框
     * @param p 玩家
     * @param dialogBox 对话框对象
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的
     */
    default void sendDialogBox(Player p , DialogBox dialogBox) throws ServiceErrorSendMsgException{

    }

    /**
     * 向玩家BUFF状态栏组件添加一个状态
     * @param uuid 玩家ID
     * @param state 状态
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的
     */
    default void addState(String uuid , State state) throws ServiceErrorSendMsgException{

    }

    /**
     * 向玩家BUFF状态栏组件修改一个状态
     * @param uuid 玩家ID
     * @param state 状态
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的
     */
    default void updateState(String uuid , State state) throws ServiceErrorSendMsgException{

    }

    /**
     * 向玩家BUFF状态栏组件删除一个状态
     * @param uuid 玩家ID
     * @param stateId 状态ID
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的
     */
    default void removeState(String uuid , String stateId) throws ServiceErrorSendMsgException{

    }

    /**
     * 获取这个玩家的所有BUFF
     * @param uuid 玩家ID
     * @return
     */
    default List<State> getStateAll(String uuid) {
        return new ArrayList<>();
    }

    /**
     * 根据类型获取HUD槽组件
     * @param type 类型
     * @return
     */
    default List<HudSlot> listHudSlotByType(String type){
        return new ArrayList<>();
    }

    /**
     * 根据ID获取HUD槽
     * @param id slotId
     * @return
     */
    default HudSlot getHudSlotById(String id){
        return null;
    }

    /**
     * 向服务器新增一个HUD槽组件
     * @param hudSlot 实例
     * @throws ServiceErrorSendMsgException 程序遇到错误,异常中保存了需要对该玩家输出的
     */
    default void saveHudSlot(HudSlot hudSlot)throws ServiceErrorSendMsgException{

    }

    /**
     * 向玩家发送当前服务器配置的所有HUD槽组件
     * @param p 玩家
     */
    default void sendHudSlot(Player p , String type){

    }

    /**
     * 添加一个数据到指定的HUD槽中
     * @param p 玩家
     * @param hudSlotId hudSlotID
     * @param imgUrl 图片
     * @param keyCodeEnum 快捷键
     * @throws ServiceErrorSendMsgException
     */
    default void addEntityToHudSlot(Player p , String hudSlotId , String imgUrl , KeyCodeEnum keyCodeEnum) throws ServiceErrorSendMsgException{

    }

    /**
     * 使用这个HUD槽，并让其进入冷却读条
     * @param uuid 玩家ID
     * @param hudSlotId 技能ID
     * @param time 冷却时间 单位: (毫秒)
     * @param startFun 进入冷却前执行的方法
     * @param stopFun 冷却结束后执行的方法
     * @throws ServiceErrorSendMsgException
     */
    default void useHudSlot(String uuid , String hudSlotId , long time , ConsumerAndThrows<Player> startFun , ConsumerAndThrows<Player> stopFun) throws ServiceErrorSendMsgException{

    }

    /**
     * 根据ID删除HUD槽中的实体数据，槽内图片与快捷键
     * @param p 玩家ID
     * @param hudSlotId ID
     */
    default void removeHudSlotEntityById(Player p , String hudSlotId){

    }

    /**
     * 根据类型删除HUD槽中的实体数据，槽内图片与快捷键
     * @param p 玩家
     * @param type 槽类型
     */
    default void removeHudSlotEntityByType(Player p , String type){

    }

    /**
     * xy字符串变量计算,计算该X或者Y轴的算法结果
     * @param player 玩家
     * @param xOrY xy
     * @return 计算该X或者Y轴的算法结果
     */
    default int buildXY(Player player, String xOrY){
        return 0;
    }

    /**
     * 为用户打开HUD
     * @param p 玩家
     * @param hudObj HUD对象
     */
    default void sendHud(Player p , Object hudObj){

    }

事件

无