C# 事件和Unity3D

http://zijan.iteye.com/blog/871207

翻译自：
http://www.everyday3d.com/blog/index.php/2010/10/04/c-events-and-unity3d/

zijan译

（括号内是译者自己对文章和技术的理解）
（Unity3D是现在越来越流行的3D游戏引擎，它支持JavaScript，c#和Boo语言。如果你是个Unity3D的爱好者，但只会JavaScript。这里有一篇文章关于处理事件和消息传递，也许更适合你。A Useful Messaging System）

你知道C#有一个内置的事件机制吗？这个东东在Unity3D里也非常好用。下面举一个例子。

为了响应一个GameObject的事件分发，你通常要建立一个脚本继承MonoBehaviour并且实现你需要的方法。比如你想对鼠标悬停作出反应，就要创建OnMouseOver方法。通常代码会像这个样子：

1. void OnMouseOver () {
2. renderer.material.color = Color.red;
3. }

void OnMouseOver () {
  renderer.material.color = Color.red;
}

这样工作没问题。但如果你想通知另外一个对象响应这个事件（OnMouseOver事件）怎么办？

第一种方式是保持另外对象的脚本引用，然后在你的OnMouseOver方法中调用它：

1. public MyScript myScript;
2. void OnMouseOver () {
3. myScript.NotifyMouseOver();
4. }

public MyScript myScript;
void OnMouseOver () {
  myScript.NotifyMouseOver();
}

这样做没问题，但是不够好。因为你需要一直保持另外一个对象的引用，如果想通知多个对象要保持多个引用。代码会变得很乱。

Messages 消息

另一个办法是用SendMessage或SendMessageUpwards方法。看上去这是解决问题的最好办法，但是这些方法存在严重的缺陷，以我的观点，你应该尽量不去使用它们。

这些方法的语法并不灵活，你需要传递一个方法名字的字符串，这样做很容易出错。另外这些方法只能用在同一个对象的附属关系中。换句话说你只能在下面几种情况中调用SendMessage或SendMessageUpwards方法，这些方法的脚本被关联到同一个GameObject中，或者被关联到这个GameObject的祖先关系对象中。

Events 事件

幸运的是有一个更好的解决办法，这就是C#内置的事件机制。我不在这里过多的描述机制是如何工作的，你如果有兴趣可以学习相关的知识，访问MSDN手册。（译者推荐另外一篇文章，C# 中的委托和事件）

现在让我们看看如何在Unity3D中使用事件机制。

1. using UnityEngine;
2. public class EventDispatcher : MonoBehaviour {
3. public delegate void EventHandler(GameObject e);
4. public event EventHandler MouseOver;
5. void OnMouseOver () {
6. if (MouseOver != null)
7. MouseOver (this.gameObject);
8. }
9. }

using UnityEngine;
public class EventDispatcher : MonoBehaviour {
  public delegate void EventHandler(GameObject e);
  public event EventHandler MouseOver;
  void OnMouseOver () {
	if (MouseOver != null)
		MouseOver (this.gameObject);
  }
}

如果你不知道这段代码到底干什么，先不要着急。重要的是一旦你把这段代码关联到一个GameObject，只要在整个项目的任何一个脚本中保持这个对象，你就可以像下面这样处理事件：

1. private GameObject s;
2. [...]
3. s.GetComponent<EventDispatcher>().MouseOver += Listener;
4. [...]
5. void Listener(GameObject g) {
6. // g is being hovered, do something...
7. }

private GameObject s;
[...]
s.GetComponent<EventDispatcher>().MouseOver += Listener;
[...]
void Listener(GameObject g) {
   // g is being hovered, do something...
}

这种方式比用消息更灵活，因为它可以被用在任何一个脚本中，而不仅仅在同一个对象附属关系中。如果在整个应用中保持一个单例模式的对象，你就可以监听任何从这个对象分发出来的事件。

另外一个重要特点，同一个监听方法可以响应不同对象的事件。通过传递事件源对象的引用作为参数，你总会知道哪个对象分发了事件，就像我的代码展示的那样。（对于这句话可以这样理解，假如游戏中扔一颗导弹炸死了一个小兵并导致坦克减血，小兵死亡和坦克减血这两个事件都触发了同一个监听方法-玩家得分，通过传递进来的事件源对象，就能知道小兵还是坦克触发了玩家得分这个监听方法。）

References, controllers and MVC

现在让我们比较一下第一和第三种方式。在最开始的例子中（第一种方式保持另外对象的脚本引用），你需要在事件分发代码中保持监听者的对象引用，我说了这不是一个好主意。在用内置事件机制，改进的版本中（第三种方式），你需要在监听者代码中保持事件分发者的引用。你也许会问，为什么后者更好？

首先，分发者不需要知道自己事件的监听者是谁，不需要知道有多少监听者。它只负责事件的发送。在最开始的例子中（第一种方式），如果要告诉分发者停止通知监听者，你能想象这种程序判断有多么笨重吗？

事件机制中，是由监听者自己决定监听什么事件，什么时候开始监听，什么时候停止监听。像这样的对象通常用于管理程序的状态或者执行某些游戏逻辑。这个就叫做控制器，借用MVC设计模式的概念。这样我们的代码会更清晰，不易出错。（译者认为观察者设计模式更符合）

最后一点，我喜欢重载“+=”操作符去添加监听方法。现在你也许能够猜到，如果想结束监听某个事件，可以这么写：

1. s.GetComponent<EventDispatcher>().MouseOver -= Listener;

s.GetComponent<EventDispatcher>().MouseOver -= Listener;

当然你可以创建一个通用的EventDispatcher类，实现所有GameObject能够分发的事件。可以参看下面的代码。另外在实现OnGUI事件时要特别小心，如果想知道为什么，读读这篇文章。

1. using UnityEngine;
2. using System.Collections;
3. /**
4. *  A simple event dispatcher - allows to listen to events in one GameObject from another GameObject
5. *
6. *  Author: Bartek Drozdz (bartek [at] everyday3d [dot] com)
7. *
8. *  Usage:
9. *  Add this script to the object that is supposed to dispatch events.
10. *  In another objects follow this pattern to register as listener at intercept events:
11. void Start () {
12. EventDispatcher ev = GameObject.Find("someObject").GetComponent<EventDispatcher>();
13. ev.MouseDown += ListeningFunction; // Register the listener (and experience the beauty of overloaded operators!)
14. }
15. void ListeningFunction (GameObject e) {
16. e.transform.Rotate(20, 0, 0); // 'e' is the game object that dispatched the event
17. e.GetComponent<EventDispatcher>().MouseDown -= ListeningFunction; // Remove the listener
18. }
19. *  This class does not implement all standards events, nor does it allow dispatching custom events,
20. *  but you shold have no problem adding all the other methods.
21. */
22. public class EventDispatcher : MonoBehaviour
23. {
24. public delegate void EventHandler (GameObject e);
25. public delegate void CollisionHandler (GameObject e, Collision c);
26. public event EventHandler MouseOver;
27. void OnMouseOver ()
28. {
29. if (MouseOver != null)
30. MouseOver (this.gameObject);
31. }
32. public event EventHandler MouseDown;
33. void OnMouseDown ()
34. {
35. if (MouseDown != null)
36. MouseDown (this.gameObject);
37. }
38. public event EventHandler MouseEnter;
39. void OnMouseEnter ()
40. {
41. if (MouseEnter != null)
42. MouseEnter (this.gameObject);
43. }
44. public event EventHandler MouseExit;
45. void OnMouseExit ()
46. {
47. if (MouseExit != null)
48. MouseExit (this.gameObject);
49. }
50. public event EventHandler BecameVisible;
51. void OnBecameVisible ()
52. {
53. if (BecameVisible != null)
54. BecameVisible (this.gameObject);
55. }
56. public event EventHandler BecameInvisible;
57. void OnBecameInvisible ()
58. {
59. if (BecameInvisible != null)
60. BecameInvisible (this.gameObject);
61. }
62. public event CollisionHandler CollisionEnter;
63. void OnCollisionEnter (Collision c)
64. {
65. if (CollisionEnter != null)
66. CollisionEnter (this.gameObject, c);
67. }
68. public event CollisionHandler CollisionExit;
69. void OnCollisionExit (Collision c)
70. {
71. if (CollisionExit != null)
72. CollisionExit (this.gameObject, c);
73. }
74. }