Unity3D插件 Doozy UI 学习（二）：与DoozyUI的事件传递

前言

为了能让DoozyUI与项目本身可以兼容，至少需要做到以下两点：

1、通过DoozyUI 触发一个自定义的事件（比如通过点击按钮来开始游戏）。

2、通过其他模块的事件来触发DoozyUI（比如游戏失败弹出提示框）。

所以需要我们做的就是使DoozyUI与自己的逻辑互通，需要有一个中间类来传递消息。

 

通过DoozyUI向其他模块传递消息

 

1、使用UnityEvent

我们通过观察DoozyUI的结构，发现其预留了一个事件给我们：

例如在UI Button中就有这么一个事件，我们可以像给普通按钮赋值一样给他赋值一个UnityEvent，然后就可以点击触发。我们可以以此为基础来实现从Doozy UI到项目的事件传递。

 

2、关于 UI Button的事件传递

DoozyUI给UI Button设定了7个事件，分别是：

OnPointerEnter（鼠标进入）、OnPointerExit（鼠标退出）、OnClick（单击）、OnPointerDown（按下）、OnPointerUp（抬起）、OnDoubleClick（双击）和OnLongClick（长按）。

因此我们写一个类，挂载到含有 UI Button的gameObject上面：

/// <summary>
/// Dooozy UI 的事件帮助脚本；
/// 通过在UnityEvent来触发；
/// </summary>
public class DoozyUIEventHelper_Button : MonoBehaviour
{
        UIButton mUIButton;

        private void OnEnable()
        {

        }

        private void Awake()
        {
            mUIButton = GetComponent<UIButton>();
            if (mUIButton != null)
            {
                InitEvent();
                //Debug.Log("添加各个事件！");
            }
            else
            {
                Debug.LogError("需要先添加DoozyUI.UIButton组件！");
            }
        }

        void InitEvent()
        {
            mUIButton.OnPointerEnter.AddListener(OnPointerEnter);
            mUIButton.OnPointerExit.AddListener(OnPointerExit);
            mUIButton.OnClick.AddListener(OnPointerClick);
            mUIButton.OnPointerDown.AddListener(OnPointerDown);
            mUIButton.OnPointerUp.AddListener(OnPointerUp);
            mUIButton.OnDoubleClick.AddListener(OnDoubleClick);
            mUIButton.OnLongClick.AddListener(OnLongClick);
        }

        private void OnDestroy()
        {
            if (mUIButton != null)
                RemoveEvent();
        }

        void RemoveEvent()
        {

        }

        public List<E_UIEvent> ListPointerEnter = new List<E_UIEvent>();
        /// <summary>
        /// 进入；
        /// </summary>
        public void OnPointerEnter()
        {
            if (mUIButton.useOnPointerEnter)
                DispatchCMD(ListPointerEnter);
        }

        public List<E_UIEvent> ListPointerExit = new List<E_UIEvent>();
        /// <summary>
        /// 退出；
        /// </summary>
        public void OnPointerExit()
        {
            if (mUIButton.useOnPointerExit)
                DispatchCMD(ListPointerExit);
        }

        public List<E_UIEvent> ListPointerUp = new List<E_UIEvent>();
        /// <summary>
        /// 抬起；
        /// </summary>
        public void OnPointerUp()
        {
            if (mUIButton.useOnPointerUp)
                DispatchCMD(ListPointerUp);
        }

        public List<E_UIEvent> ListPointerDown = new List<E_UIEvent>();
        /// <summary>
        /// 按下；
        /// </summary>
        public void OnPointerDown()
        {
            if (mUIButton.useOnPointerDown)
                DispatchCMD(ListPointerDown);
        }

        public List<E_UIEvent> ListPointerClick = new List<E_UIEvent>();
        /// <summary>
        /// 点击事件；
        /// </summary>
        public void OnPointerClick()
        {
            if (mUIButton.Interactable)
                DispatchCMD(ListPointerClick);
        }

        public List<E_UIEvent> ListDoublePointerClick = new List<E_UIEvent>();
        /// <summary>
        /// 双击；
        /// </summary>
        public void OnDoubleClick()
        {
            if (mUIButton.useOnDoubleClick)
                DispatchCMD(ListDoublePointerClick);
        }

        public List<E_UIEvent> ListPointerLongClick = new List<E_UIEvent>();
        /// <summary>
        /// 长按；
        /// </summary>
        public void OnLongClick()
        {
            if (mUIButton.useOnLongClick)
                DispatchCMD(ListPointerLongClick);
        }

        void DispatchCMD(List<E_UIEvent> list)
        {
            int length = list.Count;
            for (int i = 0; i < length; i++)
            {
               Debug.log("触发："+list[i]);
            }
        }
}

这里的原理就是用代码给 UI Button的各个UnityEvent添加事件。

其中E_UIEvent是我自己定义的一个枚举，用来当做各个事件的唯一ID。这样就可以通过UI Button来触发自定义的事件了，而且还可以一次性触发多个事件。

 

3、关于UI Element的事件传递

同理 UI Button，但是事件类型有些不一样。UI Element有四个事件：

OnInAnimationsStart（进入动画开始），OnInAnimationsFinish（进入动画结束），OnOutAnimationsStart（退出动画开始），OnOutAnimationsFinish（退出动画结束）。

代码如下：

    /// <summary>
    /// Dooozy UI 的事件帮助脚本；
    /// 通过在UnityEvent来触发；
    /// </summary>
    public class DoozyUIEventHelper_Element : SerializedMonoBehaviour
    {

        UIElement mUIElement;

        private void Awake()
        {
            mUIElement = GetComponent<UIElement>();
            if (mUIElement != null)
            {
                InitEvent();
                //Debug.Log("添加各个事件！");
            }
            else
            {
                Debug.LogError("需要先添加DoozyUI.UIElement！");
            }
        }

        void InitEvent()
        {
            mUIElement.OnInAnimationsStart.AddListener(OnInAnimationsStart);
            mUIElement.OnInAnimationsFinish.AddListener(OnInAnimationsFinish);
            mUIElement.OnOutAnimationsStart.AddListener(OnOutAnimationsStart);
            mUIElement.OnOutAnimationsFinish.AddListener(OnOutAnimationsFinish);
        }

        private void OnDestroy()
        {
            if (mUIElement != null)
                RemoveEvent();
        }

        void RemoveEvent()
        {

        }

        public List<E_UIEvent> ListInAnimationsStart = new List<E_UIEvent>();
        /// <summary>
        /// 进入动画开始；
        /// </summary>
        public void OnInAnimationsStart()
        {
            if (mUIElement.InAnimationsEnabled)
                DispatchCMD(ListInAnimationsStart);
        }

        public List<E_UIEvent> ListInAnimationsFinish = new List<E_UIEvent>();
        /// <summary>
        /// 进入动画结束；
        /// </summary>
        public void OnInAnimationsFinish()
        {
            if (mUIElement.InAnimationsEnabled)
                DispatchCMD(ListInAnimationsFinish);
        }

        public List<E_UIEvent> ListOutAnimationsStart = new List<E_UIEvent>();
        /// <summary>
        /// 退出动画开始；
        /// </summary>
        public void OnOutAnimationsStart()
        {
            if (mUIElement.OutAnimationsEnabled)
                DispatchCMD(ListOutAnimationsStart);
        }

        public List<E_UIEvent> ListOutAnimationsFinish = new List<E_UIEvent>();
        /// <summary>
        /// 退出动画结束；
        /// </summary>
        public void OnOutAnimationsFinish()
        {
            if (mUIElement.OutAnimationsEnabled)
                DispatchCMD(ListOutAnimationsFinish);
        }

        void DispatchCMD(List<E_UIEvent> list)
        {
            int length = list.Count;
            for (int i = 0; i < length; i++)
            {
                Debug.Log(list[i].ToString());
            }
        }

    }

 

通过其他模块向DoozyUI传递消息

目前只看了一下如何打开/关闭一个UI元素。原理就是发消息至DoozyUI 的 UIMangaer，比较简单。

代码示例如下：

        /// <summary>
        /// 展示一个UI元素；
        /// </summary>
        /// <param name="elementName">元素名</param>
        /// <param name="elementCategory">元素分类</param>
        public static void ShowUIElement(string elementName, string elementCategory = DUI.UNCATEGORIZED_CATEGORY_NAME)
        {
            UIElement.ShowUIElement(elementName, elementCategory);
        }

        /// <summary>
        /// 隐藏一个UI元素；
        /// </summary>
        /// <param name="elementName">元素名</param>
        /// <param name="elementCategory">元素分类</param>
        /// <param name="instantAction">隐藏动画是否立即播放</param>
        public void HideUIElement(string elementName, string elementCategory = DUI.UNCATEGORIZED_CATEGORY_NAME, bool instantAction = false)
        {
            UIElement.HideUIElement(elementName, elementCategory, instantAction);
        }