Skip to content

基于cocos creator的UI框架, 单场景游戏管理, 管理界面更轻松!

Notifications You must be signed in to change notification settings

HuShanjun/UIFrameWorld

 
 

Repository files navigation

基于cocos creator的UI框架 有疑问可以添加我的QQ 1099263878

    中心思想, 将所有的UI窗体分为3类管理(普通窗体, 固定窗体, 弹出窗体), 在将窗体制作成预制体, 使用UIManager.getInstance().showForms("窗体名字");显示
    -- UIROOT(UIManager脚本挂载结点)
    ---- normal(普通窗体)
    ---- fixed(固定窗体)
    ---- popup(弹出窗体)
    ---- UIMaskScript(UIMaskManager挂载结点, 为窗体添加阴影)
    ---- UIAdaptationScript(AdaptationManager挂载结点, 用于窗体适配)
    不同类型的窗体放置在不同的节点上, 统一管理

项目介绍

    -- UIManager ***
            UI窗体管理类, 控制的所有窗体的加载, 显示和释放
    -- BaseUIForm **
            UI窗体的基类, 所有的窗体应当继承它, 并重写init方法
    -- UIMaskManager **
            UI窗体的遮罩管理类, 为UI窗体添加一个背景阴影
    -- UIMaskScript *
            设置遮罩样式和取消遮罩
    -- AdaptationManager **
            适配管理, 用于适配固定窗体(Fixed)的贴边处理,上下左右贴边,并且可以适配刘海屏
    -- UIType *
            设置窗体类型, 在BaseUIForm中设置其属性
    -- UILoader *
            用于加载UI窗体, 释放窗体资源

    -- ConfigUIFrame *
            配置UI窗体 名称与路径的对应关系
    -- SysDefine *
            设置一些定义的路径和对应结点名称

为什么使用UIFrame

    在传统项目中, 场景的切换, 以及各UI之间的互动效果 都不太好用, 比如场景的切换, 场景的切换使用loadScene,一句话就搞定了, 但是还有一个弊端, 就是两个场景之间的消息传递十分麻烦, 频繁的切换场景也十分销毁资源, 另一个就是UI的复用, a场景中的一个UI我希望在b场景中也使用, 一般就是制作成预制体, 或者是常驻结点, 无论是哪一种都不太方便, 而使用UIFrame之后, 只需要将重复使用的结点挂在Fixed结点上就好了, 下面看一张图

    我们将这个场景分成5个部分, 
    1, 表示Top部分的玩家信息
    2, 表示左侧的玩家列表
    3, 表示房间入口按钮
    4, 表示底部的功能列表
    5, 表示背景

    前4个我们将其挂载在Fixed结点上, 5号挂载在Normal结点上, 并设置HideOther属性, 并且使用AdaptationManager组件使结点在个个位置适配

    演示视屏: 

使用方法

    下载: 进入script文件夹中, 将UIFrame文件夹拷贝到你自己的项目中

    场景结点设置, 如果UIROOT及子节点设置的和我不同, 请到SysDefind中修改

    1, 新建一个UI窗体, 并为它创建一个脚本, 脚本继承自BaseUIForm, 重写属性CurrentUIType设置为窗体对应属性
    2, 重写init方法, 并获取参数obj, 对UI窗体进行数据初始化, 每一次执行showUIForm方法都会触发init方法
    3, 重写ShowPopUpAnimation方法,播放入场动画,重写HidePopUpAnimation方法, 播放出场动画
    ~~4, 在config/ConfigUIForm 中配置窗体名称与对应的路径~~
    5, 通过UIManager.GetInstance().ShowUIForms("uiformname", null); 方法展示窗体
    6, 更多详细内容, 请见test中的示例

2019/10/16 新增功能

1, 将BaseUIBinder分离出来作为BaseUIView的父类, 如果希望使用BaseUIBinder的功能, 请为你的结点添加View组件

为什么这么做? 对于UIForm的控制我尝试过多种方法, 这一次是希望实现一个类似MVC的控制结构, 对于一个UIForm, 我们为其添加C(控制)和V(视图)组件 例如, 我在LoginForm预制体添加的组件一样, 将Form的动画, 显示放在View脚本中, 而事件的监听, 游戏逻辑则放在Control脚本中, 当然View脚本不是必须的 你也可以只实现Control脚本

2, 场景切换(在本单场景管理, 即是Normal结点的更换), 添加加载过度动画

如何使用: 1, 在游戏的Main脚本中设置UIIndependentManager.getInstance().setLoadingForm("UIForm/LoadingForm"); 过度场景 2, 在加载场景时使用UIManager.GetInstance().ShowUIFormWithLoading("UIForm/HallForm"); 如上, 在HallForm中需要提前加载的UIform或者其他资源, 可以放在HallForm的load方法中, 这样就会在load内资源加载完毕, 在关闭LoadingForm, 完美实现场景切换

3, 新增了Independent结点与类型 Independent类似常驻结点, 是独立于其他窗体的特殊窗体, 不会受到其他窗体的影响, 例如加载过度窗体, 就属于独立窗体, 不会因为其他窗体设置了HideOther属性就将其隐藏

2019年9月26日新增功能

扩展button, 为button组件添加了

  1. 点击button播放音效
  2. 屏蔽连续点击

需要注意的是, ButtonPlus.ts需要配合插件使用, 插件路径位于UIFrameWorld\packages\helloworld, 原因是 在ButtonPlus中@inspector('packages://helloworld/inspector.js'), 需要引入插件中的inspector.js, 用户也可以在inspector自定义编辑器上ButtonPlus显示格式.

2019年9月19日新增功能

添加UIHelper自动绑定规范命名的结点, UIHelper的功能, 在用脚本控制UI的 时候, 绑定UI是一件很烦人的事情, 尤其是将UI拖到面板上绑定, 就更加繁琐, 或者在onload, start上 使用getChildByName() 或者cc.find() 查找结点, 又会显得代码冗长大部分时候, 在我创建这个结点的时候, 我就已经想好要让这个结点完成什么功能了(针对渲染结点), 所有我希望在取名字的时候,通过特殊的命名规则, 就可以在脚本中直接使用此结点, UIHelper就来完成此功能

  1. 给结点取一个规范的名字, 例如 _Label$NickName _Sprite&HeadImage

我分别解释每一部分的意思

  • _表示这个结点需要被自动绑定
  • Label表示脚本中属性的类型
  • $表示分隔符, 后面紧接这个表示变量名字
  • NickName就表示这个变量的名字

所以在脚本中, 你可以通过 this._Labels.NickName 获得这个结点上的cc.Label组件

需要注意的是 自动绑定的结点必须是是挂载脚本的结点或者子节点, 如图

只会在BindTest结点的子节点自动绑定结点, 那么我现在有一个结点希望自动绑定, 但是其父节点没有挂载脚本, 怎么办呢. UIHelper还提供了了bindNode()方法, 将对方结点或者其父节点传入, 那么你就可以在其他脚本将结点自动绑定

还需要注意的是 重复绑定, 因为每次进行查询绑定操作时, 都会对其所有的子节点进行查找, 所有可能会出现重复绑定!

8月3日新增功能

BaseUIForm中添加CloseAndDestory属性, 当此属性为true时, 关闭此窗体将会销毁此结点,并且释放结点资源 对于已经显示的窗体, 不会二次显示

About

基于cocos creator的UI框架, 单场景游戏管理, 管理界面更轻松!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.8%
  • JavaScript 7.2%