Unity 事件系统

using System;
using System.Collections.Generic;
using UnityEngine;

namespace Framework {
	/// <summary>
	/// 事件系统
	/// </summary>
	public class EventSystem : Singleton<EventSystem> {
		private const string LOG_CALLBACK_NULL = "Event callback {0} is null";
		private const string LOG_GET = "Can't find out event callback:{0}";

		/// <summary>
		/// 派发事件
		/// </summary>
		public static event Action<int, object> OnBroadcastEvent;

		/// <summary>
		/// 事件回调表 [键:事件ID 值:事件对象]
		/// </summary>
		private Dictionary<int, EventObject> m_CallbackMap = new Dictionary<int, EventObject> ();

		/// <summary>
		/// 注册事件
		/// </summary>
		/// <param name="id">事件ID</param>
		/// <param name="onCallback">事件回调</param>
		public static void Register (int id, Action<object> onCallback) {
			if (onCallback == null) {
				Debug.LogError (string.Format (LOG_CALLBACK_NULL, id));
				return;
			}

			EventObject eventObject = null;

			if (!Instance.m_CallbackMap.TryGetValue (id, out eventObject)) {
				eventObject = new EventObject {
					callback = onCallback
				};
				Instance.m_CallbackMap[id] = eventObject;
			} else {
				eventObject.callback -= onCallback;
				eventObject.callback += onCallback;
			}
		}

		/// <summary>
		/// 派发事件
		/// </summary>
		/// <param name="id">事件ID</param>
		/// <param name="msg">事件消息</param>
		public static void Broadcast (int id, object msg = null) {
			if (OnBroadcastEvent != null) {
				OnBroadcastEvent.Invoke (id, msg);
			}
			EventObject eventObject = null;
			if (!Instance.m_CallbackMap.TryGetValue (id, out eventObject)) {
				Debug.Log (string.Format (LOG_GET, id));
				return;
			}

			//检测是否启用缓存
			if (eventObject.isCache) {
				eventObject.cacheQueue.Enqueue (msg); //启用缓存,消息放入队列
				return;
			}

			//回调
			if (eventObject.callback != null) {
				eventObject.callback.Invoke (msg);
			}
		}

		/// <summary>
		/// 是否含有事件
		/// </summary>
		/// <param name="id">事件ID</param>
		/// <returns>返回结果</returns>
		public static bool HasEvent (int id) {
			return Instance.m_CallbackMap.ContainsKey (id);
		}

		/// <summary>
		/// 注销事件
		/// </summary>
		/// <param name="id">事件ID</param>
		/// <param name="onCallback">事件回调</param>
		public static void Cancel (int id, Action<object> onCallback) {
			if (onCallback == null) {
				Debug.LogError (string.Format (LOG_CALLBACK_NULL, id));
				return;
			}

			EventObject eventObject = null;
			if (Instance.m_CallbackMap.TryGetValue (id, out eventObject)) {
				eventObject.callback -= onCallback;
			}
		}

		/// <summary>
		/// 清理事件
		/// </summary>
		/// <param name="id">事件ID</param>
		public static void Clear (int id) {
			EventObject eventObject = null;
			if (Instance.m_CallbackMap.TryGetValue (id, out eventObject)) {
				eventObject.callback = null;
			}
		}

		/// <summary>
		/// 设置缓存消息
		/// </summary>
		/// <param name="id">事件ID</param>
		/// <param name="isCache">是否缓存</param>
		public static void SetCache (int id, bool isCache) {
			EventObject eventObject = null;
			if (!Instance.m_CallbackMap.TryGetValue (id, out eventObject)) {
				eventObject = new EventObject ();
				Instance.m_CallbackMap[id] = eventObject;
			}

			eventObject.isCache = isCache;
			if (!isCache) {
				if (eventObject.callback == null) {
					eventObject.cacheQueue.Clear ();
				} else {
					while (eventObject.cacheQueue.Count > 0) {
						object msg = eventObject.cacheQueue.Dequeue ();
						eventObject.callback.Invoke (msg);
					}
				}
			}
		}

		private class EventObject {
			/// <summary>
			/// 事件回调
			/// </summary>
			public Action<object> callback;

			/// <summary>
			/// 是否缓存
			/// </summary>
			public bool isCache = false;

			/// <summary>
			/// 缓存队列
			/// </summary>
			public Queue<object> cacheQueue = new Queue<object> ();
		}
	}
}

 

### 使用 Unity 中的事件系统Unity 引擎中,事件系统主要用于处理用户界面 (UI) 的交互逻辑。为了使 UI 组件能够响应用户的操作,开发者可以利用内置的 `UnityEvent` 或者创建自定义类型的 `UnityEvent` 来满足特定需求。 对于简单的场景,默认提供的 `UnityEvent` 就已经足够使用;然而当需要传递参数给回调函数时,则可以通过继承泛型类 `UnityEvent<T>` 创建带有参数支持的新类型[^1]: ```csharp using UnityEngine; using UnityEngine.Events; [System.Serializable] public class UnityEventInt : UnityEvent<int> {} ``` 此代码片段展示了如何定义一个新的名为 `UnityEventInt` 的事件处理器,它可以接受整数作为其唯一参数,并允许将该数值传入到监听器的方法里去执行进一步的操作。 除了上述提到的内容外,在实际项目开发过程中还需要注意一些细节来确保 UGUI 事件系统的正常运作。例如,只有实现了 Selectable 接口的对象才能被 EventSystem 正确识别并触发相应的行为[^3]。这意味着如果希望某个按钮或其他控件能接收点击等动作的话,那么这些对象应该属于 Button、Toggle 等预设类别之一或者自行实现必要的接口成员。 另外值得注意的是,整个 UGUI 体系依赖于 Canvas 和 Graphic Raycaster 进行渲染和射线投射计算以确定哪个图形元素处于鼠标指针下方从而决定要分发哪些消息给谁处理。因此设置好这两个组件也是必不可少的一部分工作[^2]。 最后提醒一点,虽然这里主要讨论了有关 GUI 方面的应用案例,但实际上 Unity 提供了一套完整的 C# 委托机制以及更底层的消息路由功能可供探索,这使得游戏内部不同模块之间的通信变得非常灵活多变。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值